Skip to main content

final class atoti_directquery_jdbc.ConnectionConfig

Config to connect to an external database through JDBC.

auto_multi_column_array_conversion : AutoMultiColumnArrayConversion | None = None

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

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:

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.

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

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

password : RedactedStr | None = None

The password to connect to the database. Passing it in this separate attribute keeps it out of the connection string, and a repr() shows <redacted> in place of it. The connection string reaches Atoti’s logs; this attribute does not. A property named in redacted_properties for the same purpose takes precedence over this attribute. If None, a password is expected to be present in url.

password_parameter_name : str | None = None

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.

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

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

redacted_properties : FrozenMapping[str, RedactedStr]

The driver properties whose values must not be logged. A property carrying or locating a secret, such as a password, the passphrase of a private key or an OAuth client secret, goes here rather than in url. Atoti keeps these values out of its logs, and a repr() shows each name with <redacted> in place of its value, so the properties that are set can be seen without the secrets they carry. A connection string offers neither assurance. Every other property, including the one selecting the authentication method, belongs in url. The accepted names are the ones this database’s own driver documents. A driver enumerating the properties it accepts rejects a name it does not know rather than ignoring it. A property named here takes precedence over password, which remains the way to pass a password without naming the driver’s own property for it.
The driver decides what it writes to its own logs. This attribute keeps a secret out of Atoti’s logs, not out of every log.

sql_dialect_key : str

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

url : str

The JDBC connection string.