snowflakeauth: Authentication Helpers for 'Snowflake'

Description

Authentication helpers for 'Snowflake'. It provides compatibility with authentication approaches supported by the 'Snowflake Connector for Python' https://pypi.org/project/snowflake-connector-python and the 'Snowflake CLI' https://pypi.org/project/snowflake-cli.

Author(s)

Maintainer: E. David Aja david@posit.co

Authors:

• Aaron Jacobs aaron.jacobs@posit.co

Other contributors:

• Posit Software, PBC [copyright holder, funder]

See Also

Useful links:

• https://posit-dev.github.io/snowflakeauth/

• https://github.com/posit-dev/snowflakeauth

• Report bugs at https://github.com/posit-dev/snowflakeauth/issues

Reports whether a default connection is available

Description

Reports whether a default connection is available

Usage

has_a_default_connection(...)

Arguments

Value

Logical value indicating whether a default connection is available.

Examples

has_a_default_connection()

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

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:

• account: A Snowflake account identifier.

• user: A Snowflake username.

• role: The role to use for the connection.

• schema: The default schema to use for the connection.

• database: The default database to use for the connection.

• warehouse: The default warehouse to use for the connection.

• authenticator: The authentication method to use for the connection.

• private_key or private_key_file: A path to a PEM-encoded private key for key-pair authentication.

• private_key_file_pwd: The passphrase for the private key, if any.

• token: The OAuth token to use for authentication.

• token_file_path: A path to an OAuth token to use for authentication.

• password: The user's Snowflake password.

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"
)

Get credentials for a Snowflake connection

Description

Get credentials for a Snowflake connection

Usage

snowflake_credentials(params, role = NULL, spcs_endpoint = NULL, ...)

Arguments

Value

A list of HTTP headers.

Examples

# Obtain authentication headers for accessing Snowflake APIs
snowflake_credentials(
 snowflake_connection()
)


# If the application is in Snowpark Container Services,
# a different collection of headers are returned:
snowflake_credentials(
 snowflake_connection(),
 spcs_endpoint = "https://example-accountname.snowflakecomputing.app"
)