-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add dbt-deltastream documentation #8014
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
427d434
Add dbt-deltastream documentation
Kayrnt 3bdbeb7
Merge branch 'current' into deltastream-setup
amychen1776 dfc9735
Merge branch 'current' into deltastream-setup
amychen1776 1b83de4
Merge branch 'current' into deltastream-setup
amychen1776 40c23a4
Merge branch 'current' into deltastream-setup
mirnawong1 64cc916
Apply suggestions from code review
mirnawong1 baa4443
Update website/docs/reference/resource-configs/deltastream-configs.md
mirnawong1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
96 changes: 96 additions & 0 deletions
96
website/docs/docs/core/connect-data-platform/deltastream-setup.md
This file contains hidden or 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,96 @@ | ||
| --- | ||
| title: "DeltaStream setup" | ||
| description: "Read this guide to learn about the DeltaStream warehouse setup in dbt." | ||
| meta: | ||
| maintained_by: Community | ||
| authors: 'DeltaStream Team' | ||
| github_repo: 'deltastreaminc/dbt-deltastream' | ||
| pypi_package: 'dbt-deltastream' | ||
| min_core_version: 'v1.10.0' | ||
| cloud_support: Not Supported | ||
| min_supported_version: '?' | ||
| slack_channel_name: '#db-deltastream' | ||
| platform_name: 'DeltaStream' | ||
| config_page: '/reference/resource-configs/deltastream-configs' | ||
| --- | ||
|
|
||
| import SetUpPages from '/snippets/_setup-pages-intro.md'; | ||
|
|
||
| <SetUpPages meta={frontMatter.meta} /> | ||
|
|
||
| ## Connecting to DeltaStream with **dbt-deltastream** | ||
|
|
||
| To connect to DeltaStream from dbt, you'll need to add a [profile](/docs/core/connect-data-platform/connection-profiles) | ||
| to your `profiles.yml` file. A DeltaStream profile conforms to the following syntax: | ||
|
|
||
| <File name='profiles.yml'> | ||
|
|
||
| ```yaml | ||
| <profile-name>: | ||
| target: <target-name> | ||
| outputs: | ||
| <target-name>: | ||
| type: deltastream | ||
|
|
||
| # Required Parameters | ||
mirnawong1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| token: [ your-api-token ] # Authentication token for DeltaStream API | ||
| database: [ your-database ] # Target database name | ||
| schema: [ your-schema ] # Target schema name | ||
| organization_id: [ your-org-id ] # Organization identifier | ||
|
|
||
| # Optional Parameters | ||
mirnawong1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| url: [ https://api.deltastream.io/v2 ] # DeltaStream API URL, defaults to https://api.deltastream.io/v2 | ||
| timezone: [ UTC ] # Timezone for operations, defaults to UTC | ||
| session_id: [ <empty string> ] # Custom session identifier for debugging purpose | ||
| role: [ <empty string> ] # User role | ||
| store: [ <empty string> ] # Target store name | ||
| compute_pool: [ <empty string> ] # Compute pool name to be used if any else use the default compute pool | ||
| ``` | ||
|
|
||
| </File> | ||
|
|
||
| ### Description of DeltaStream Profile Fields | ||
mirnawong1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | Field | Required | Description | | ||
| |-------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `type` | ✅ | This must be included either in `profiles.yml` or in the `dbt_project.yml` file. Must be set to `deltastream`. | | ||
| | `token` | ✅ | Authentication token for DeltaStream API. This should be stored securely, preferably as an environment variable. | | ||
| | `database` | ✅ | Target default database name in DeltaStream where your dbt models will be created. | | ||
| | `schema` | ✅ | Target default schema name within the specified database. | | ||
| | `organization_id` | ✅ | Organization identifier that determines which DeltaStream organization you're connecting to. | | ||
| | `url` | ❌ | DeltaStream API URL. Defaults to `https://api.deltastream.io/v2` if not specified. | | ||
| | `timezone` | ❌ | Timezone for operations. Defaults to `UTC` if not specified. | | ||
| | `session_id` | ❌ | Custom session identifier for debugging purposes. Helps track operations in DeltaStream logs. | | ||
| | `role` | ❌ | User role within the DeltaStream organization. If not specified, uses the default role associated with the token. | | ||
| | `store` | ❌ | Target default store name. Stores represent external system connections (Kafka, PostgreSQL, etc.) in DeltaStream. | | ||
| | `compute_pool` | ❌ | Compute pool name to be used for models that require computational resources. If not specified, uses the default compute pool. | | ||
|
|
||
| ## Security Best Practices | ||
mirnawong1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| When configuring your project for production, it is strongly recommended to use environment variables to store sensitive information such as the authentication token: | ||
|
|
||
| <File name='profiles.yml'> | ||
|
|
||
| ```yaml | ||
| your_profile_name: | ||
| target: prod | ||
| outputs: | ||
| prod: | ||
| type: deltastream | ||
| token: "{{ env_var('DELTASTREAM_API_TOKEN') }}" | ||
| database: "{{ env_var('DELTASTREAM_DATABASE') }}" | ||
| schema: "{{ env_var('DELTASTREAM_SCHEMA') }}" | ||
| organization_id: "{{ env_var('DELTASTREAM_ORG_ID') }}" | ||
| ``` | ||
|
|
||
| </File> | ||
|
|
||
| ## Troubleshooting Connections | ||
mirnawong1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| If you encounter issues connecting to DeltaStream from dbt, verify the following: | ||
|
|
||
| ### Authentication Issues | ||
mirnawong1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - Ensure your API token is valid and has not expired | ||
| - Verify the token has appropriate permissions for the target organization | ||
| - Check that the `organization_id` matches your DeltaStream organization | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.