-
Notifications
You must be signed in to change notification settings - Fork 978
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
74 additions
and
9 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
website/docs/docs/core/connect-data-platform/cratedb-setup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| 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 [PostgreSQL profile setup]. | ||
|
|
||
| CrateDB targets are configured exactly the same way, see also [PostgreSQL | ||
| configuration], 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 | ||
| [PostgreSQL configuration]: https://docs.getdbt.com/reference/resource-configs/postgres-configs | ||
| [PostgreSQL profile setup]: https://docs.getdbt.com/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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,12 @@ | ||
| --- | ||
| title: "No specifc configurations for this Adapter" | ||
| title: "No specific configurations for this adapter" | ||
| id: "no-configs" | ||
| --- | ||
|
|
||
| If you were guided to this page from a data platform setup article, it most likely means: | ||
|
|
||
| - Setting up the profile is the only action the end-user needs to take on the data platform, or | ||
| - The subsequent actions the end-user needs to take are not currently documented | ||
| - The subsequent actions the end-user needs to take are not currently documented, or | ||
| - Relevant information is provided on the documentation pages of the data platform vendor. | ||
|
|
||
| If you'd like to contribute to data platform-specific configuration information, refer to [Documenting a new adapter](/guides/adapter-creation) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters