ClickhouseSource

ClickhouseSources hold the connection information to ClickHouse data sources. Supports both self-hosted ClickHouse and ClickHouse Cloud.

Example

Simple (Self-hosted with Native TCP)HTTP ProtocolClickHouse Cloud

    sources:
      - name: clickhouse_source
        type: clickhouse
        host: localhost
        port: 9000
        database: default
        username: default
        password: {{ env_var('CLICKHOUSE_PASSWORD') }}

    sources:
      - name: clickhouse_http
        type: clickhouse
        host: localhost
        port: 8123
        database: default
        username: default
        password: {{ env_var('CLICKHOUSE_PASSWORD') }}
        protocol: http

    sources:
      - name: clickhouse_cloud
        type: clickhouse
        host: your-instance.clickhouse.cloud
        port: 8443
        database: default
        username: default
        password: {{ env_var('CLICKHOUSE_PASSWORD') }}
        protocol: http
        secure: true

Note

Recommended environment variable use is covered in the sources overview.

Attributes

Field	Type	Default	Description
path	string	None	A unique path to this object
name	string	None	The unique name of the object across the entire project.
file_path	string	None	The path to the file that contains the object definition.
after_connect	string	None
host	string	None	The host url of the database.
port	integer	9000	The ClickHouse port. Default 9000 for native TCP, use 8123 for HTTP.
database		None	The database that the Visivo project will use in queries.
username	string	None	Username for the database.
password	string or string	None	Password corresponding to the username.
db_schema	string	None	The schema that the Visivo project will use in queries.
type	string	None
protocol	string	native	Connection protocol: 'native' (TCP, recommended) or 'http'.
secure	boolean	False	Use secure TLS connection. Required for ClickHouse Cloud with HTTP protocol.
connection_pool_size	integer	1	The pool size that is used for this connection.