{"id":20578105,"url":"https://github.com/timeplus-io/dbt-proton","last_synced_at":"2025-07-13T23:35:36.472Z","repository":{"id":234710618,"uuid":"706384940","full_name":"timeplus-io/dbt-proton","owner":"timeplus-io","description":"dbt adapter for Timeplus ","archived":false,"fork":false,"pushed_at":"2024-12-21T01:38:59.000Z","size":35,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-21T02:29:30.333Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timeplus-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-17T20:59:34.000Z","updated_at":"2024-09-24T23:14:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"d3954770-9676-4b4f-9127-b0d6f7a637cf","html_url":"https://github.com/timeplus-io/dbt-proton","commit_stats":null,"previous_names":["timeplus-io/dbt-proton"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timeplus-io%2Fdbt-proton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timeplus-io%2Fdbt-proton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timeplus-io%2Fdbt-proton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timeplus-io%2Fdbt-proton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timeplus-io","download_url":"https://codeload.github.com/timeplus-io/dbt-proton/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234280441,"owners_count":18807457,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T06:10:34.166Z","updated_at":"2025-01-16T22:17:16.185Z","avatar_url":"https://github.com/timeplus-io.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/silentsokolov/dbt-clickhouse/master/etc/dbt-logo-full.svg\" alt=\"dbt logo\" width=\"300\"/\u003e\n\u003c/p\u003e\n\n[![build](https://github.com/silentsokolov/dbt-clickhouse/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/silentsokolov/dbt-clickhouse/actions/workflows/build.yml)\n\n# dbt-proton\n\nThis plugin ports [dbt](https://getdbt.com) functionality to [Timeplus Proton](https://github.com/timeplus-io/proton).\n\n\n### Installation\n\nUse your favorite Python package manager to install the app from PyPI, e.g.\n\n```bash\npip install dbt-proton\n```\n\n### Development\nFollow the [dbt Documentation])(https://docs.getdbt.com/docs/core/pip-install) to install dbt with pip.\n```shell\npython3.10 -m venv proton-dbt-env\nsource proton-dbt-env/bin/activate\npip install dbt-core\npip install -r dev_requirements.txt\n```\nThen run `pip install -e .` to install the current dev code.\nRun `pytest tests/unit/test_adapter.py` to run basic tests.\nRun `pytest tests/integration/proton.dbtspec` to run integration tests.\n\n### Supported features\n\n- [x] Table materialization\n- [x] View materialization\n- [x] Incremental materialization\n- [x] Seeds\n- [x] Sources\n- [x] Docs generate\n- [x] Tests\n- [x] Snapshots (experimental)\n- [ ] Ephemeral materialization\n\n# Usage Notes\n\n### Database\n\nThe dbt model `database.schema.table` is not compatible with ClickHouse because ClickHouse does not support a `schema`.\nSo we use a simple model `schema.table`, where `schema` is the ClickHouse's database. Please, don't use `default` database!\n\n### Model Configuration\n\n| Option         | Description                                                                                                                                          | Required?                         |\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|\n| engine         | The table engine (type of table) to use when creating tables                                                                                         | Optional (default: `MergeTree()`) |\n| order_by     | 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()`)     |\n| partition_by | 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                          |\n\n### Example Profile\n\n```\nyour_profile_name:\n  target: dev\n  outputs:\n    dev:\n      type: proton\n      schema: [database name] # default default\n      host: [db.url.proton] # default localhost\n\n      # optional\n      port: [port]  # default 8463\n      user: [user]\n      password: [abc123]\n      cluster: [cluster name]\n      verify: [verify] # default False\n      secure: [secure] # default False\n      connect_timeout: [10] # default 10\n      send_receive_timeout: [300] # default 300\n      sync_request_timeout: [5] # default 5\n      compress_block_size: [1048576] # default 1048576\n      compression: ['lz4'] # default '' (disable)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimeplus-io%2Fdbt-proton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimeplus-io%2Fdbt-proton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimeplus-io%2Fdbt-proton/lists"}