dbConnect,TeradataOdbcDriver-method: Connect to a Teradata ODBC compatible database

Description

Connect to a Teradata ODBC compatible database

Usage

# S4 method for TeradataOdbcDriver
dbConnect(drv, dsn = NULL, ...,
  timezone = "UTC", encoding = "UTF-8", bigint = c("integer64",
  "integer", "numeric", "character"), driver = NULL, server = NULL,
  DBCName = NULL, database = "", uid = NULL, pwd = NULL,
  charset = "ASCII", tmode = c("ANSI", "TERA"), dbms.name = NULL,
  .connection_string = NULL)

Arguments

drv

an object that inherits from '>DBIDriver, or an existing '>DBIConnection object (in order to clone an existing connection).

dsn

The Data Source Name.

...

Additional ODBC keywords, these will be joined with the other arguments to form the final connection string.

timezone

The Server time zone. Useful if the database has an internal timezone that is not 'UTC'. If the database is in your local timezone set to Sys.timezone(). See OlsonNames() for a complete list of available timezones on your system.

encoding

Alias of charset.

bigint

The R type that SQL_BIGINT types should be mapped to, default is bit64::integer64, which allows the full range of 64 bit integers.

driver

The ODBC driver name.

server

Alias of DBCName.

DBCName

The server hostname.

database

The database on the server.

uid

The user identifier.

pwd

The password to use.

charset

Character Set. "ASCII"(default), "UTF8" or "UTF16".

tmode

TMODE. "ANSI"(default) or "TERA".

dbms.name

The database management system name. This should normally be queried automatically by the ODBC driver. This name is used as the class name for the OdbcConnect object returned from dbConnect(). However if the driver does not return a valid value it can be set manually with this parameter.

.connection_string

A complete connection string, useful if you are copy pasting it from another source. If this argument is used any additional arguments will be appended to this string.

Details

The connection string keywords are driver dependent. The parameters documented here are common, but some drivers may not accept them. Please see the specific driver documentation for allowed parameters, https://www.connectionstrings.com is also a useful resource of example connection strings for a variety of databases.