Skip to content

Latest commit

 

History

History
120 lines (77 loc) · 4.5 KB

README.md

File metadata and controls

120 lines (77 loc) · 4.5 KB
Raw

R Interface & SDK for the EXASOL Database

Build Status codecov.io Issue Stats Issue Stats

Please note that this is an open source project which is officially supported by EXASOL. For any question, you can contact our support team.

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 fast 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 from the EXASOL Community Portal.

Status

The package is currently tested with R 3.3.1. The packages however (DBI 0.3.1 and a fork of DBItest 1.0-1) are not the current versions. The EXASOL R package may however work with DBI 0.4.1, but until this is resolved the fitting older packages can be loaded from here:

The low-level methods as regards exa.readData, exa.writeData and exa.createScript may work as expected, so should the DBI connection methods (dbConnect etc.; all tests passed). DBI querying methods also get close to being production ready.

Writing tests have not yet been implemented (only quick-tests), but it hopefully happens in the near future.

dplyr methods have been moved to a separate package.

Code coverage of tests:

codecov.io

Getting started

Prerequisites

  1. Install developer extensions for R to be able to build from sources

    For Windows: Install Rtools For Linux: Install the R-devel (RPM) or r-base-dev (Debian) package.

    The packages might change over time, so generally you can go to the official R-project website download section for your OS to find the package that are needed to build packages.

  2. Make sure you have ODBC and EXASOL ODBC installed and configured on your system. We recommend to create a DSN pointing to your database instance. Read the README of EXASOL's ODBC driver package for details.

    On Linux, you also need to install the development files for ODBC. Therefore please install unixodbc-devel (RPM) or unixodbc-dev (Debian) package.

  3. The R package devtools must be available as it contains the install_github() method and the things needed to build the package.

Installation

To load the EXASOL package from GitHub and have R compile and build the package for use:

devtools::install_github("EXASOL/r-exasol")

Loading the package

To use the package import it as follows:

library(exasol)

Use

devtools::install_github("exasol/r-exasol")
library(exasol)

# display package documentation with examples for each method
?exasol
# display documentation of individual commands with Exasol-specific parameters
?dbConnect

# connect to EXASOL DB with an ODBC DSN
con <- dbConnect("exa", dsn="ExaSolo", schema="TEST")
# OR connect to EXASOL DB running on default port (8563) with a hostname, default 'sys' user and default schema ('SYS')
con <- dbConnect("exa", exahost = "<hostname>:8563", uid = "sys", pwd = "<password>")


# list all tables in EXASOL (returns a character vector).
dbListTables(con)


# send a query and read the result into a data.frame
df <- dbGetQuery(con, "select * from TEST.MYTAB")


#send a query and return a result set handler, then fetch 2 rows
res <- dbSendQuery(con, "select * from TEST.MYTAB")
df <- dbFetch(res, 2)


# disconnect
dbDisconnect(con)

Documentation

The package comes with documentation accessible from R via the command ?exasol.