Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt

Use this file to discover all available pages before exploring further.

​
final class atoti_directquery_snowflake.ConnectionConfig

Config to connect to a Snowflake database.

​
Example

>>> import os
>>> from atoti_directquery_snowflake import ConnectionConfig
>>> connection_config = ConnectionConfig(
...     url="jdbc:snowflake://"
...     + os.environ["SNOWFLAKE_ACCOUNT_IDENTIFIER"]
...     + ".snowflakecomputing.com/?user="
...     + os.environ["SNOWFLAKE_USERNAME"],
...     password=os.environ["SNOWFLAKE_PASSWORD"],
... )
>>> external_database = session.connect_to_external_database(connection_config)

​
array_agg_wrapper_function_name : str | None = None

The name of the User Defined Function to use to wrap the aggregations on arrays to improve performance. This function must be defined in Snowflake and accessible to the role running the queries.

​
auto_multi_column_array_conversion : AutoMultiColumnArrayConversion | None = None

When not None, multi-column array conversion will be performed automatically.

​
cache : bool = True

Whether to look for query results in the external database query cache.

​
column_clustered_queries : ‘all’ | ‘feeding’ = ‘feeding’

Control which queries will use clustering columns.

​
feeding_query_timeout : Duration = datetime.timedelta(seconds=3600)

Timeout for queries performed on the external database during feeding phases. The feeding phases are:

​
feeding_warehouse_name : str | None = None

The name of the warehouse to use for the initial feeding. If None, the main warehouse will be used.

​
lookup_mode : ‘allow’ | ‘warn’ | ‘deny’ = ‘warn’

Whether lookup queries on the external database are allowed. Lookup can be very slow and expensive as the database may not enforce primary keys.

​
main_warehouse_name : str | None = None

The name of the warehouse to use for all other queries than the ones handled by the feeding warehouse. If None, the warehouse defined in :attr: url will be used. If :attr: url does not specify a warehouse, the user’s default warehouse will be used.

​
max_sub_queries : Annotated[int, Field(gt=0)] = 500

Maximum number of sub queries performed when splitting a query into multi-step queries.

​
password : str | None = None

The password to connect to the database. Passing it in this separate attribute prevents it from being logged alongside the connection string. If None, a password is expected to be present in url.

​
query_timeout : Duration = datetime.timedelta(seconds=300)

Timeout for queries performed on the external database outside feeding phases.

​
time_travel : bool = True

Whether to use time travel in queries.

​
url : str

The JDBC connection string. If feeding_warehouse_name is not None, the warehouse cannot be specified in the URL. See https://docs.snowflake.com/en/user-guide/jdbc-configure.html#jdbc-driver-connection-string for more information.