From 81d9536eb6f96ac9830ce7e700d9224250d209db Mon Sep 17 00:00:00 2001
From: Andreas Motl <andreas.motl@crate.io>
Date: Tue, 26 Nov 2024 21:42:27 +0100
Subject: [PATCH] Add information about database adapter `dbt-cratedb2`

---
 .../connect-data-platform/cratedb-setup.md    | 61 +++++++++++++++++++
 website/sidebars.js                           |  1 +
 2 files changed, 62 insertions(+)
 create mode 100644 website/docs/docs/core/connect-data-platform/cratedb-setup.md

diff --git a/website/docs/docs/core/connect-data-platform/cratedb-setup.md b/website/docs/docs/core/connect-data-platform/cratedb-setup.md
new file mode 100644
index 00000000000..cc8900863ef
--- /dev/null
+++ b/website/docs/docs/core/connect-data-platform/cratedb-setup.md
@@ -0,0 +1,61 @@
+---
+title: "CrateDB setup"
+description: "Read this guide to learn about the CrateDB warehouse 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: 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/postgres-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     # CrateDB's only catalog is `crate`.
+      schema: doc       # Define schema. `doc` is the default.
+      search_path: doc  # Use the same value like `schema` by default.
+```
+
+</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/
diff --git a/website/sidebars.js b/website/sidebars.js
index 08494e4c713..870cdff4690 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -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",