DatabaseConnector: createConnectionDetails – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

createConnectionDetails

Description

createConnectionDetails creates a list containing all details needed to connect to a database. There are three ways to call this function:

createConnectionDetails(dbms, user, password, server, port, extraSettings, oracleDriver, pathToDriver)
createConnectionDetails(dbms, connectionString, pathToDriver)
createConnectionDetails(dbms, connectionString, user, password, pathToDriver)

Arguments

`dbms`	The type of DBMS running on the server. Valid values are "oracle" for Oracle "postgresql" for PostgreSQL "redshift" for Amazon Redshift "sql server" for Microsoft SQL Server "pdw" for Microsoft Parallel Data Warehouse (PDW) "netezza" for IBM Netezza "bigquery" for Google BigQuery "sqlite" for SQLite
`user`	The user name used to access the server.
`password`	The password for that user.
`server`	The name of the server.
`port`	(optional) The port on the server to connect to.
`extraSettings`	(optional) Additional configuration settings specific to the database provider to configure things as security for SSL. These must follow the format for the JDBC connection for the RDBMS specified in dbms.
`oracleDriver`	Specify which Oracle drive you want to use. Choose between `"thin"` or `"oci"`.
`connectionString`	The JDBC connection string. If specified, the `server`, `port`, `extraSettings`, and `oracleDriver` fields are ignored. If `user` and `password` are not specified, they are assumed to already be included in the connection string.
`pathToDriver`	Path to a folder containing the JDBC driver JAR files. See `downloadJdbcDrivers` for instructions on how to download the relevant drivers.

Details

This function creates a list containing all details needed to connect to a database. The list can then be used in the connect function.

Value

A list with all the details needed to connect to a database.

DBMS parameter details

Depending on the DBMS, the function arguments have slightly different interpretations:

Oracle:

user. The user name used to access the server
password. The password for that user
server. This field contains the SID, or host and servicename, SID, or TNSName: '<sid>', '<host>/<sid>', '<host>/<service name>', or '<tnsname>'
port. Specifies the port on the server (default = 1521)
extraSettings The configuration settings for the connection (i.e. SSL Settings such as "(PROTOCOL=tcps)")
oracleDriver The driver to be used. Choose between "thin" or "oci".
pathToDriver The path to the folder containing the Oracle JDBC driver JAR files.

Microsoft SQL Server:

user. The user used to log in to the server. If the user is not specified, Windows Integrated Security will be used, which requires the SQL Server JDBC drivers to be installed (see details below).
password. The password used to log on to the server
server. This field contains the host name of the server
port. Not used for SQL Server
extraSettings The configuration settings for the connection (i.e. SSL Settings such as "encrypt=true; trustServerCertificate=false;")
pathToDriver The path to the folder containing the SQL Server JDBC driver JAR files.

Microsoft PDW:

user. The user used to log in to the server. If the user is not specified, Windows Integrated Security will be used, which requires the SQL Server JDBC drivers to be installed (see details below).
password. The password used to log on to the server
server. This field contains the host name of the server
port. Not used for SQL Server
extraSettings The configuration settings for the connection (i.e. SSL Settings such as "encrypt=true; trustServerCertificate=false;")
pathToDriver The path to the folder containing the SQL Server JDBC driver JAR files.

PostgreSQL:

user. The user used to log in to the server
password. The password used to log on to the server
server. This field contains the host name of the server and the database holding the relevant schemas: <host>/<database>
port. Specifies the port on the server (default = 5432)
extraSettings The configuration settings for the connection (i.e. SSL Settings such as "ssl=true")
pathToDriver The path to the folder containing the PostgreSQL JDBC driver JAR files.

Redshift:

user. The user used to log in to the server
password. The password used to log on to the server
server. This field contains the host name of the server and the database holding the relevant schemas: <host>/<database>
port. Specifies the port on the server (default = 5439)
extraSettings The configuration settings for the connection (i.e. SSL Settings such as "ssl=true&sslfactory=com.amazon.redshift.ssl.NonValidatingFactory")
pathToDriver The path to the folder containing the RedShift JDBC driver JAR files.

Netezza:

user. The user used to log in to the server
password. The password used to log on to the server
server. This field contains the host name of the server and the database holding the relevant schemas: <host>/<database>
port. Specifies the port on the server (default = 5480)
extraSettings The configuration settings for the connection (i.e. SSL Settings such as "ssl=true")
pathToDriver The path to the folder containing the Netezza JDBC driver JAR file (nzjdbc.jar).

Impala:

user. The user name used to access the server
password. The password for that user
server. The host name of the server
port. Specifies the port on the server (default = 21050)
extraSettings The configuration settings for the connection (i.e. SSL Settings such as "SSLKeyStorePwd=*****")
pathToDriver The path to the folder containing the Impala JDBC driver JAR files.

SQLite:

server. The path to the SQLIte file

To be able to use Windows authentication for SQL Server (and PDW), you have to install the JDBC driver. Download the .zip from Microsoft and extract its contents to a folder. In the extracted folder you will find the file sqljdbc_9.2/enu/auth/x64/mssql-jdbc_auth-9.2.0.x64.dll (64-bits) or ssqljdbc_9.2/enu/auth/x86/mssql-jdbc_auth-9.2.0.x86.dll (32-bits), which needs to be moved to location on the system path, for example to c:/windows/system32. If you not have write access to any folder in the system path, you can also specify the path to the folder containing the dll by setting the environmental variable PATH_TO_AUTH_DLL, so for example Sys.setenv("PATH_TO_AUTH_DLL" = "c:/temp") Note that the environmental variable needs to be set before calling connect for the first time.

Examples

## Not run: 
connectionDetails <- createConnectionDetails(dbms = "postgresql",
                                             server = "localhost/postgres",
                                             user = "root",
                                             password = "blah")
conn <- connect(connectionDetails)
dbGetQuery(conn, "SELECT COUNT(*) FROM person")
disconnect(conn)

## End(Not run)

DatabaseConnector

Connecting to Various Database Platforms

v4.0.2

Apache License

Authors

Martijn Schuemie [aut, cre], Marc Suchard [aut], Observational Health Data Science and Informatics [cph], Microsoft Inc. [cph] (SQL Server JDBC driver), PostgreSQL Global Development Group [cph] (PostgreSQL JDBC driver), Oracle Inc. [cph] (Oracle JDBC driver), Amazon Inc. [cph] (RedShift JDBC driver)

Initial release

2021-04-12