dlt.destinations.impl.clickhouse.factory

ClickHouseTypeMapper Objects

class ClickHouseTypeMapper(TypeMapperImpl)

View source on GitHub

to_db_datetime_type

def to_db_datetime_type(column: TColumnSchema,
                        table: PreparedTableSchema = None) -> str

View source on GitHub

Map timestamp type to appropriate ClickHouse datetime type with or without timezone.

to_db_integer_type

def to_db_integer_type(column: TColumnSchema,
                       table: PreparedTableSchema = None) -> str

View source on GitHub

Map integer precision to the appropriate ClickHouse integer type.

clickhouse Objects

class clickhouse(Destination[ClickHouseClientConfiguration,
                             "ClickHouseClient"])

View source on GitHub

__init__

def __init__(credentials: Union[ClickHouseCredentials, str, Dict[str, Any],
                                Type[Connection]] = None,
             destination_name: str = None,
             environment: str = None,
             **kwargs: Any) -> None

View source on GitHub

Configure the ClickHouse destination to use in a pipeline.

All arguments provided here supersede other configuration sources such as environment variables and dlt config files.

Arguments:

• credentials Union[ClickHouseCredentials, str, Dict[str, Any], Type[Connection]], optional - Credentials to connect to the clickhouse database. Can be an instance of ClickHouseCredentials or a connection string in the format clickhouse://user:password@host:port/database
• destination_name str, optional - Name of the destination, can be used in config section to differentiate between multiple of the same type
• environment str, optional - Environment of the destination
• **kwargs Any - Additional arguments passed to the destination config