class atoti_directquery_clickhouse.ClickhouseConnectionInfo#

Information needed to connect to a ClickHouse database.

__init__(url, /, *, lookup_mode='warn', max_sub_queries=500, password=None, query_timeout=datetime.timedelta(seconds=3600))#

Create a ClickHouse connection info.

  • url (str) – The connection string. The pattern is: (clickhouse|ch):(https|http|...)://login:password@host:port/database?prop=value. For example: "clickhouse:https://user:password@localhost:8123/mydb". When a parameter is missing, the default value will be used.

  • lookup_mode (Literal['allow', 'warn', 'deny']) – 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 (int) – Maximum number of subqueries performed when splitting a query into multi-steps queries.

  • password (str | None) –

    The password to connect to the database.

    Passing it in this separate parameter allows to avoid having it logged alongside the connection string.

    If None, a password is expected to be present in the passed url.

  • query_timeout (timedelta) – Timeout for queries performed on the external database.