dbConnect: dbConnect
In EXASOL/r-exasol: R Interface & SDK for the EXASOL Database

dbConnect,EXADriver-method

R Documentation

dbConnect

Description

dbConnect

Usage

## S4 method for signature 'EXADriver'
dbConnect(
  drv,
  exahost = "",
  uid = "",
  pwd = "",
  schema = "SYS",
  exalogfile = tempfile(pattern = "EXAODBC_", fileext = ".log"),
  logmode = "NONE",
  encryption = "N",
  sslcertificate = "",
  uselegacyencryption = "",
  autocommit = "Y",
  querytimeout = "0",
  connectionlcctype = Sys.getlocale(category = "LC_CTYPE"),
  connectionlcnumeric = Sys.getlocale(category = "LC_NUMERIC"),
  ...,
  dsn = "",
  connection_string = ""
)

## S4 method for signature 'character'
dbConnect(drv, ...)

## S4 method for signature 'EXAConnection'
dbConnect(drv, ...)

Arguments

`drv`	Existing connection
`exahost`	DNS or IP (or range of IPs) and port of the database cluster, e.g. '10.0.2.15..20:8563'
`uid`	DB username, e.g. 'sys'
`pwd`	DB user password, e.g. 'exasol'
`schema`	Schema in EXASOL db which is opened directly after the connection.
`exalogfile`	The EXASOL ODBC driver log file. By standard a tempfile is created. Log data may be accessed with 'EXAlog(EXAConnection)'.
`logmode`	EXASOL ODBC driver log mode. Allowed options are: NONE no log is written (default) DEFAULT most important function calls & SQL commands VERBOSE also additional data about internal steps & result data ON ERROR ONLY only errors are logged DEBUGCOMM extended logs, similar to verbose but w/o data & parameter tables
`encryption`	ODBC encryption. By default off. Switch on with 'Y'.
`sslcertificate`	The name and path of the certificate file (cert.pem) used by SSL. You can use SSL_VERIFY_NONE to disable server verification and SSL_VERIFY_SERVER to enable it. By default the server certificate check is enabled.
`uselegacyencryption`	'Y' = ChaCha encryption instead of SSL.
`autocommit`	By default 'Y'. If 'Y' each SQL statement is committed. 'N' means that no commits are executed automatically. The transaction will be rolled back on disconnect, which causes the loss of all data written during the transaction.
`querytimeout`	Time EXASOL DB computes a query before it is aborted. The default `'0'` (zero) means no timeout, i.e. runs until finished.
`connectionlcctype`	Sets the connection locale `LC CTYPE`. The default is the setting of the client's current R session.
`connectionlcnumeric`	Sets the connection locale `LC NUMERIC`. The default is the setting of the client's current R session.
`...`	Additional parameters to the connection string. If a connection is cloned, these override the old connection settings.
`dsn`	A preconfigured ODBC Data Source Name. Parameter being evaluated with priority to `EXAHOST`.
`connection_string`	Alternatively to everything else, a custom ODBC connection sting can be provided. See EXASOL DB manual secion 4.2.5 for details, available at https://docs.exasol.com/.

Value

A fresh EXAConnection object.

Methods (by class)

EXADriver: Creates a new connection to an EXASOL Database.
character: Creates a connection to an EXASOL Database based on string.
EXAConnection: Creates a connection to an EXASOL Database based on an existing connection.

Author(s)

EXASOL AG <opensource@exasol.com>

Examples

## Not run: 
 con <- dbConnect("exa", dsn = "EXASolo")
 con <- dbConnect("exa", exahost = "212.209.123.20..25:8563",
                  uid = "peter", pwd = "password123", schema = "sales")

## End(Not run)

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