Skip to content

Commit

Permalink
Platform connections: Add new data platform adapter for CrateDB
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Dec 11, 2024
1 parent 8f79c09 commit a2a372c
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 0 deletions.
60 changes: 60 additions & 0 deletions website/docs/docs/core/connect-data-platform/cratedb-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: "CrateDB setup"
description: "Read this guide to learn about the CrateDB data platform setup in dbt."
id: "cratedb-setup"
meta:
maintained_by: Crate.io, Inc.
authors: 'CrateDB maintainers'
github_repo: 'crate/dbt-cratedb2'
pypi_package: 'dbt-cratedb2'
min_core_version: 'v1.0.0'
cloud_support: Not Supported
min_supported_version: 'n/a'
slack_channel_name: 'Community Forum'
slack_channel_link: 'https://community.cratedb.com/'
platform_name: 'CrateDB'
config_page: '/reference/resource-configs/no-configs'
---

import SetUpPages from '/snippets/_setup-pages-intro.md';

<SetUpPages meta={frontMatter.meta}/>


[CrateDB] is compatible with PostgreSQL, so its dbt adapter strongly depends on
dbt-postgres, documented at [Postgres profile setup].

CrateDB targets are configured exactly the same way, with just a few things to
consider which are special to CrateDB. Relevant details are outlined at [using
dbt with CrateDB], which also includes up-to-date information.


## Profile configuration

CrateDB targets should be set up using a configuration like this minimal sample
of settings in your [`profiles.yml`] file.

<File name='~/.dbt/profiles.yml'>

```yaml
cratedb_analytics:
target: dev
outputs:
dev:
type: cratedb
host: [clustername].aks1.westeurope.azure.cratedb.net
port: 5432
user: [username]
pass: [password]
dbname: crate # Do not change this value. CrateDB's only catalog is `crate`.
schema: doc # Define the schema name. CrateDB's default schema is `doc`.
```
</File>
[CrateDB]: https://cratedb.com/database
[Postgres profile setup]: /docs/core/connect-data-platform/postgres-setup
[`profiles.yml`]: https://docs.getdbt.com/docs/core/connect-data-platform/profiles.yml
[using dbt with CrateDB]: https://cratedb.com/docs/guide/integrate/dbt/
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ const sidebarSettings = {
"docs/core/connect-data-platform/athena-setup",
"docs/core/connect-data-platform/glue-setup",
"docs/core/connect-data-platform/clickhouse-setup",
"docs/core/connect-data-platform/cratedb-setup",
"docs/core/connect-data-platform/databend-setup",
"docs/core/connect-data-platform/decodable-setup",
"docs/core/connect-data-platform/doris-setup",
Expand Down

0 comments on commit a2a372c

Please sign in to comment.