exasol-package: R Interface & SDK for the EXASOL Database

exasol-packageR Documentation

R Interface & SDK for the EXASOL Database

Description

The EXASOL R Package offers interface functionality such as connecting to, querying and writing into an EXASOL Database (version 5 onwards). It is optimised for massively parallel reading & writing from and to a multinode cluster. Implemented are DBI compliant methods for database access, querying and modiifcation. The package integrates with EXASOL's InDB R UDF capabilities, which allows to deploy and execute R code dynamically from an R application running on a client.

EXASOL is an InMemory RDBMS that runs in a MPP cluster (shared-nothing) environment. Leading the TPC-H benckmark, it is considered the fastest analytical data warehouse available. The community edition can be downloaded for free on https://docs.exasol.com/get_started/communityedition.htm.

Package index

DBI: General

EXAObject-class

A virtual meta Object for all other EXASOL DBI objects.

dbGetInfo
summary
dbIsValid

Checks if an EXAObject is still valid.

dbDataType

Determine the EXASOL data type of an object.

DBI: Driver-related

EXADriver-class

An interface driver object to the EXASOL Database.

dbGetInfo
summary
dbDriver

Load database drivers.

dbUnloadDriver

Unload a driver.

dbConnect

Creates a connection to an EXASOL Database.

DBI: Connection-related

EXAConnection-class

An object holding a connection to an EXASOL Database.

dbGetInfo
summary
dbDisconnect

Disconnects the connection.

dbSendQuery

Sends an SQL statment to an EXASOL DB, prepares for result fetching.

dbGetQuery

Executes the query, fetches and returns the entire result set.

dbGetException
dbListResults
dbListFields
dbListTables
dbReadTable

Reads a DB table.

dbWriteTable

Writes a data.frame into a table. If the table does not exist, it is created.

dbExistsTable

Checks if a table exists in an EXASOL DB.

dbRemoveTable

Removes a table.

dbBegin

Starts a DB transaction.

dbEnd

Ends a DB transaction.

dbCommit

Sends a commit.

dbRollback

Rolls the current DB transaction back.

DBI: Result set-related

EXAResult-class

An object that is associated with a result set in an EXASOL Database.

dbGetInfo
summary
dbFetch

Fetches a subset of an result set.

dbClearResult

Frees all resources associated with an EXAResult.

dbColumnInfo
dbGetStatement
dbHasCompleted
dbGetRowsAffected
dbGetRowCount

Low-level methods

exa.readData

Execute a SQL query on an EXASolution database and read results fast.

exa.writeData

Write a data.frame into an EXASOL table fast.

exa.createScript

Deploys an R function as an UDF in the EXASolution database.

dbCurrentSchema

Fetches and outputs the current schema from an EXASOL DB.

Author(s)

EXASOL AG & Community

Maintainer: Thomas Ubensee <ext.Thomas.Uebensee@exasol.com>

References

  1. The development version of the package is available on https://github.com/EXASOL/r-exasol

  2. Bugs and improvements may be noted on https://github.com/EXASOL/r-exasol/issues

  3. Downloads & manuals related to the EXASOL Database are at https://docs.exasol.com/get_started/communityedition.htm


EXASOL/r-exasol documentation built on Aug. 28, 2023, 2:32 a.m.