snowflake_connection {snowflakeauth}R Documentation

Snowflake connection parameter configuration

Description

Reads Snowflake connection parameters from the connections.toml and config.toml files used by the Snowflake Connector for Python and the Snowflake CLI, or specifies them for a connection manually.

Usage

snowflake_connection(name = NULL, ..., .config_dir = NULL)

Arguments

name

A named connection. Defaults to ⁠$SNOWFLAKE_DEFAULT_CONNECTION_NAME⁠ if set, the default_connection_name from the config.toml file (if present), and finally the ⁠[default]⁠ section of the connections.toml file, if any. See Snowflake's documentation for details.

...

Additional connection parameters. See Common parameters.

.config_dir

The directory to search for a connections.toml and config.toml file. Defaults to ⁠$SNOWFLAKE_HOME⁠ or ⁠~/.snowflake⁠ if that directory exists, otherwise it falls back to a platform-specific default. See Snowflake's documentation for details.

Value

An object of class "snowflake_connection".

Common parameters

The following is a list of common connection parameters. A more complete list can be found in the documentation for the Snowflake Connector for Python:

Examples


# Read the default connection parameters from an existing
# connections.toml file:
conn <- snowflake_connection()

# Read a named connection from an existing connections.toml file:
conn <- snowflake_connection(name = "default")

# Override specific parameters for a connection:
conn <- snowflake_connection(
  schema = "myschema",
  warehouse = "mywarehouse"
)

# Pass connection parameters manually, which is useful if there is no
# connections.toml file. For example, to use key-pair authentication:
conn <- snowflake_connection(
  account = "myaccount",
  user = "me",
  private_key = "rsa_key.p8"
)

[Package snowflakeauth version 0.1.2 Index]