Skip to content

Commit dbebe79

Browse files
committed
Updated README.md
1 parent 048c79b commit dbebe79

1 file changed

Lines changed: 14 additions & 44 deletions

File tree

README.md

Lines changed: 14 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,13 @@
88

99

1010
The Exasol R Package offers interface functionality such as connecting to, querying and writing
11-
into an Exasol Database (version 5 onwards). It is optimized for fast reading &
12-
writing from and to a multinode cluster. Implemented are DBI compliant methods for database access,
13-
querying and modification. The package integrates with Exasol's in-DB R UDF capabilities, which
14-
allows to deploy and execute R code dynamically from an R application running on a client.
11+
into an Exasol Database (version 7.1 onwards) via Exasol's native WebSocket protocol. No ODBC
12+
driver installation is required; the package communicates directly with the database using
13+
JSON-over-WebSocket for command operations and HTTP/HTTPS for high-speed bulk data transfer.
14+
It is optimized for fast reading & writing from and to a multinode cluster. Implemented are
15+
DBI compliant methods for database access, querying and modification. The package integrates
16+
with Exasol's in-DB R UDF capabilities, which allows to deploy and execute R code dynamically
17+
from an R application running on a client.
1518

1619
Exasol is an in-memory RDBMS that runs in a MPP cluster (shared-nothing) environment.
1720
Leading the TPC-H benchmark, it is considered the fastest analytical data warehouse available.
@@ -20,13 +23,13 @@ Leading the TPC-H benchmark, it is considered the fastest analytical data wareho
2023

2124
## Status
2225

23-
Github CI build validates the package r-exasol against R versions 4.0, 4.1, 4.2, and 4.3. You can use the [remotes package](https://remotes.r-lib.org/) to install specific versions of RODBC. Please note that packages DBI 0.3.1 and a fork of DBItest 1.0-1 are not the latest versions. The Exasol R package may however work with DBI 0.4.1, but until this is resolved appropriate and compatible older packages can be loaded from here:
26+
Github CI build validates the package r-exasol against R versions 4.0, 4.1, 4.2, and 4.3. Please note that DBI 0.3.1 and a fork of DBItest 1.0-1 are not the latest versions. The Exasol R package may however work with DBI 0.4.1, but until this is resolved appropriate and compatible older packages can be loaded from here:
2427

2528
- https://github.com/marcelboldt/DBI
2629
- https://github.com/marcelboldt/DBItest
2730

28-
For Windows only:
29-
* As this package uses C++14 code, it needs at least RTools >= 4.0.0. Hence, it works only on R >= 4.0.0.
31+
For Windows only:
32+
* As this package uses C++17 code, it needs at least RTools >= 4.0.0. Hence, it works only on R >= 4.0.0.
3033
* Please note that the version of RTools must match the installed version of R (RTools 4.2 for R >= 4.2, RTools 4.0 for R4.0/4.1), check https://cran.r-project.org/bin/windows/Rtools/ for further information
3134

3235
The low-level methods such as regards `exa.readData`, `exa.writeData` and `exa.createScript` may work as expected, so
@@ -38,11 +41,6 @@ Following test were implemented:
3841

3942
`dplyr` methods have been moved to a [separate package](https://github.com/marcelboldt/r-exasol-dplyr).
4043

41-
### Known issues
42-
43-
1. ODBC drivers 7.1.1 & 7.1.2 under MacOsX BigSur have a dependency issue. If you have problems under MacOsX and see an error message like ```...libexaodbc-io418sys.dylib not found```, please update to the latest ODBC driver, version 7.1.3 works fine.
44-
2. The Exasol ODBC driver does not support encoding of curly braces for passwords in the connection string: You can use curly braces to encode semicolons in passwords in the connection string, like `...,PWD={he;llo},...`. However, passwords like `he{{;o` are currently not supported.
45-
4644
## Getting started
4745

4846
### Prerequisites
@@ -60,48 +58,22 @@ Following test were implemented:
6058
official R-project website download section for your OS to find the
6159
package that are needed to build packages.
6260

63-
2. Make sure you have ODBC and Exasol ODBC installed and
64-
configured on your system. Go to the [download page](https://docs.exasol.com/connect_exasol/drivers/odbc.htm) and select your Exasol version in the left menu. Then scroll down to 'Download ODBC Driver' and choose the appropriate version.
65-
66-
Once installed, we recommend to create a DSN pointing to
67-
your database instance. Read the README of Exasol's ODBC
68-
driver package for details.
69-
70-
<span style="color:red">*Important:*</span> Since v6.1.0 the Exasol ODBC driver for Linux and MacOsX are not bundled anymore in r-exasol and you need to
71-
configure properly the ODBC driver on your system.
72-
If you do not indicate a DSN calling dbConnect, r-exasol will look for a Data Source named <em>"EXASolution Driver"</em> and
73-
you must have the respective driver configured properly, for example the following line in your ```/etc/odbcinst.ini```:
74-
```
75-
[EXASolution Driver]
76-
Driver=/usr/lib/libexaodbc-uo2214lv2.so
77-
```
78-
(This change does not affect Windows: Under Windows the ODBC driver already had to be configured on previous versions.)
79-
80-
#### Linux
81-
On Linux, you also need to install the development files for ODBC.
82-
Therefore please install `unixodbc-devel` (RPM) or `unixodbc-dev`
83-
(Debian) package.
84-
85-
#### MacOsX
86-
On MacOsX you can install `unixodbc` with Homebrew:
87-
```brew install unixodbc```
88-
89-
3. The R package **devtools** must be available as it contains the `install_github()` method
61+
2. The R package **devtools** must be available as it contains the `install_github()` method
9062
and the things needed to build the package.
9163

9264
You can install it in R with: ```install.packages("devtools")```.
9365
If you followed step 1., this installation should work on Linux/Windows.
9466
Under MacOsX you might need to install additional dependencies, please check the [devtools page](https://www.rdocumentation.org/packages/devtools/versions/1.13.6)
9567

9668

97-
4. OpenSSL
69+
3. OpenSSL (required for the encrypted WebSocket connection and HTTPS bulk transfer)
9870
For Windows: The package downloads the required DLL's during the installation process.
9971

10072
For Linux: Install using the common package manager, for example: ```apt install libssl-dev```
10173

10274
For MacOsX: Install via brew: ```brew install openssl```.
10375

104-
5. Install the necessary dependencies, such as RODBC or the DBI packages. For the versions of these package, checkout the section [Status](#status). Have a look into the [Github Actions Docker](https://github.com/exasol/r-exasol/blob/main/tests/Dockerfile), if you look for an example, how to install the necessary dependencies.
76+
4. Install the necessary R dependencies, such as DBI. For the versions of these packages, checkout the section [Status](#status). Have a look into the [Github Actions Docker](https://github.com/exasol/r-exasol/blob/main/tests/Dockerfile), if you look for an example, how to install the necessary dependencies.
10577

10678

10779
### Installation
@@ -129,9 +101,7 @@ library(exasol)
129101
# display documentation of individual commands with Exasol-specific parameters
130102
?dbConnect
131103

132-
# connect to Exasol DB with an ODBC DSN
133-
con <- dbConnect("exa", dsn="ExaSolo", schema="test")
134-
# OR connect to Exasol DB running on default port (8563) with a hostname, default 'sys' user and default schema ('SYS'), using an encryption channel
104+
# connect to Exasol DB on default port (8563) with hostname, 'sys' user and 'SYS' schema, using an encrypted (TLS) WebSocket
135105
con <- dbConnect("exa", exahost = "<hostname>:8563", uid = "sys", pwd = "<password>", encryption = "Y")
136106

137107
# list all tables in Exasol (returns a character vector).

0 commit comments

Comments
 (0)