Metadata-Version: 2.1
Name: dbt-clickhouse
Version: 0.19.0.1
Summary: The Clickhouse plugin for dbt (data build tool)
Home-page: https://github.com/silentsokolov/dbt-clickhouse
Author: Dmitriy Sokolov
Author-email: silentsokolov@gmail.com
License: MIT
Description: <p align="center">
          <img src="https://raw.githubusercontent.com/silentsokolov/dbt-clickhouse/master/etc/dbt-logo-full.svg" alt="dbt logo" width="300"/>
        </p>
        
        ![build](https://github.com/silentsokolov/dbt-clickhouse/workflows/build/badge.svg?branch=master)
        
        # dbt-clickhouse
        
        This plugin ports [dbt](https://getdbt.com) functionality to [Clickhouse](https://clickhouse.tech/).
        
        We have not tested extensively against older versions of Clickhouse. The plugin uses syntax that requires version 20.11 or newer.
        
        ### Installation
        
        Use your favorite Python package manager to install the app from PyPI, e.g.
        
        ```bash
        pip install dbt-clickhouse
        ```
        
        ### Supported features
        
        - [x] Table materialization
        - [x] View materialization
        - [x] Incremental materialization
        - [x] Seeds
        - [x] Sources
        - [x] Docs generate
        - [x] Snapshots (experimental)
        - [ ] Ephemeral materialization
        
        # Usage Notes
        
        ### Database
        
        The dbt model `database.schema.table` is not compatible with Clickhouse because Clickhouse does not support a `schema`.
        So we use a simple model `schema.table`, where `schema` is the Clickhouse's database. Please, don't use `default` database!
        
        ### Model Configuration
        
        | Option         | Description                                                                                                                                          | Required?                         |
        |----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|
        | engine         | The table engine (type of table) to use when creating tables                                                                                         | Optional (default: `MergeTree()`) |
        | order_cols     | A tuple of column names or arbitrary expressions. This allows you to create a small sparse index that helps find data faster.                        | Optional (default: `tuple()`)     |
        | partition_cols | A partition is a logical combination of records in a table by a specified criterion. The partition key can be any expression from the table columns. | Optional                          |
        
        ### Example Profile
        
        ```
        your_profile_name:
          target: dev
          outputs:
            dev:
              type: clickhouse
              schema: [database name]
              host: [db.clickhouse.com]
        
              # optional
              port: [port]  # default 9000
              user: [user]
              password: [abc123]
        ```
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
