Skip to content
RelationalAI Private Docs

SnowflakeConnectionBase

relationalai.config.connections.snowflake

Configure a Snowflake Snowpark session.

This abstract base class defines common Snowflake connection fields and provides SnowflakeConnectionBase.get_session to create a Session. Use one of the concrete authenticators (for example UsernamePasswordAuth).

The session is cached on the instance; call BaseConnection.clear_session_cache to force a fresh session on the next access.

Notes

Section titled “Notes”

Do not instantiate this class directly.

Attributes

Section titled “Attributes”

.account

Section titled “.account”
SnowflakeConnectionBase.account: str

Snowflake account identifier.

.warehouse

Section titled “.warehouse”
SnowflakeConnectionBase.warehouse: str

Snowflake warehouse name.

.rai_app_name

Section titled “.rai_app_name”
SnowflakeConnectionBase.rai_app_name: (str, optional)

RAI application name in Snowflake (default: “RELATIONALAI”).

.role

Section titled “.role”
SnowflakeConnectionBase.role: (str, optional)

Role to set on the session.

.database

Section titled “.database”
SnowflakeConnectionBase.database: (str, optional)

Default database.

.schema_

Section titled “.schema_”
SnowflakeConnectionBase.schema_: (str, optional)

Default schema (set via schema=...).

.client_session_keep_alive

Section titled “.client_session_keep_alive”
SnowflakeConnectionBase.client_session_keep_alive: (bool, optional)

Snowflake connector keep-alive setting.

.client_session_keep_alive_heartbeat_frequency

Section titled “.client_session_keep_alive_heartbeat_frequency”
SnowflakeConnectionBase.client_session_keep_alive_heartbeat_frequency: (int, optional)

Snowflake connector heartbeat frequency in seconds.

.login_timeout

Section titled “.login_timeout”
SnowflakeConnectionBase.login_timeout: (int, optional)

Snowflake connector login timeout in seconds.

.network_timeout

Section titled “.network_timeout”
SnowflakeConnectionBase.network_timeout: (int, optional)

Snowflake connector network timeout in seconds.

.socket_timeout

Section titled “.socket_timeout”
SnowflakeConnectionBase.socket_timeout: (int, optional)

Snowflake connector socket timeout in seconds.

.session_parameters

Section titled “.session_parameters”
SnowflakeConnectionBase.session_parameters: (dict, optional)

Snowflake session parameters to pass to the connector.

Methods

Section titled “Methods”

.get_session()

Section titled “.get_session()”
SnowflakeConnectionBase.get_session() -> snowflake.snowpark.Session

Return a Snowpark session for this connection.

The session is created on first access from this connection’s configuration and cached on the instance. Call BaseConnection.clear_session_cache to force a fresh session on the next access.

Returns:

  • snowflake.snowpark.Session - The configured Snowpark session.

Inheritance Hierarchy

Section titled “Inheritance Hierarchy”
SnowflakeConnectionBaseBaseConnectionpydantic.BaseModelabc.ABC

Subclassed By

Section titled “Subclassed By”
 config > connections > snowflake
├──  ExternalBrowserAuth
├──  JWTAuth
├──  OAuthAuth
├──  OAuthAuthorizationCodeAuth
├──  OAuthClientCredentialsAuth
├──  ProgrammaticAccessTokenAuth
├──  UsernamePasswordAuth
└──  UsernamePasswordMFAAuth