ConnectionAttributes: Supported Connection Attributes

In odbc: Connect to ODBC Compatible Databases (using the DBI Interface)

Supported Connection Attributes

Description

These (pre) connection attributes are supported and can be passed as part of the dbConnect call in the named list attributes parameter:

Details

• azure_token: This should be a string scalar; in particular Azure Active Directory authentication token. Only for use with Microsoft SQL Server and with limited support away from the OEM Microsoft driver.

• sf_private_key: This parameter is specific to establishing a connection to snowflake and is understood by both OEM, as well as Posit pro drivers. Argument should be a string (scalar); in particular a PEM-encoded private key. Note, if using private key authentication, the authenticator connection string attribute must be set to SNOWFLAKE_JWT. Using this connection attribute is an alternative to using the PRIV_KEY_FILE connection string attribute.

• sf_private_key_password: If key passed using sf_private_key is encrypted, you can use this attribute to communicate the password.

Examples

## Not run: 
conn <- dbConnect(
  odbc::odbc(),
  dsn = "my_azure_mssql_db",
  Encrypt = "yes",
  attributes = list("azure_token" = .token)

conn <- dbConnect(
 odbc::odbc(),
 dsn = "snowflake",
 attributes = list("sf_private_key" = paste(readLines("<path-to-private-key-file>"), collapse="\n"),
                   "sf_private_key_password" = "<optional-private-key-encryption-password>"),
 authenticator = "SNOWFLAKE_JWT")

## End(Not run)

odbc documentation built on Dec. 24, 2025, 9:06 a.m.