ConnectionConfig

atoti_directquery_jdbc.ConnectionConfig(
    *,
    password: str | None = None,
    auto_multi_column_array_conversion: AutoMultiColumnArrayConversion | None = None,
    column_clustered_queries: ‘all’ | ‘feeding’ = 'feeding',
    feeding_query_timeout: Duration = datetime.timedelta(seconds=3600),
    lookup_mode: ‘allow’ | ‘warn’ | ‘deny’ = 'warn',
    max_sub_queries: Annotated[int, Field(gt=0)] = 500,
    query_timeout: Duration = datetime.timedelta(seconds=300),
    url: str,
    sql_dialect_key: str,
    password_parameter_name: str | None = None,
)

Config to connect to an external database through JDBC.

​

Attributes

​

url

The JDBC connection string.

​

sql_dialect_key

The key of the SQL dialect to use. The dialect will typically be provided with an extra JAR.

​

password_parameter_name

The name of the query string parameter in which password should be added to url. Unused when password is None, required when it is not.

​

auto_multi_column_array_conversion

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

​

column_clustered_queries

Control which queries will use clustering columns.

​

feeding_query_timeout

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

• the initial load to feed aggregate_providers and hierarchies;
• the refresh operations.

​

lookup_mode

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

​

max_sub_queries

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

​

password

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

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