-
Notifications
You must be signed in to change notification settings - Fork 211
docs: add DuckDB, Dremio, Spark support to OSS documentation #2136
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
Open
devin-ai-integration
wants to merge
5
commits into
docs
Choose a base branch
from
devin/ELE-5266-1772375633-docs
base: docs
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
85d1d7e
docs: add DuckDB, Dremio, Spark support to OSS documentation
devin-ai-integration[bot] cd95275
Merge remote-tracking branch 'origin/docs' into devin/ELE-5266-177237…
devin-ai-integration[bot] 2f00505
fix: replace placeholder icons with official DuckDB, Dremio, and Spar…
devin-ai-integration[bot] 679a232
fix: show both Dremio Cloud and Software profile options in CLI docs
devin-ai-integration[bot] 1b6879a
fix: add Dremio Cloud and Software profiles to all-profiles.mdx
devin-ai-integration[bot] 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| title: "Athena" | ||
| --- | ||
|
|
||
| import AthenaCli from '/snippets/cli/athena-cli.mdx'; | ||
|
|
||
|
|
||
|
|
||
| <Tabs> | ||
| <Tab title="Elementary CLI"> | ||
| <AthenaCli /> | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### Have a question? | ||
|
|
||
| We are available | ||
| on [Slack](https://elementary-data.com/community), reach out | ||
| for any kind of help! |
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,19 @@ | ||
| --- | ||
| title: "DuckDB" | ||
| --- | ||
|
|
||
| import DuckdbCli from '/snippets/cli/duckdb-cli.mdx'; | ||
|
|
||
|
|
||
|
|
||
| <Tabs> | ||
| <Tab title="Elementary CLI"> | ||
| <DuckdbCli /> | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### Have a question? | ||
|
|
||
| We are available | ||
| on [Slack](https://elementary-data.com/community), reach out | ||
| for any kind of help! |
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,19 @@ | ||
| --- | ||
| title: "Spark" | ||
| --- | ||
|
|
||
| import SparkCli from '/snippets/cli/spark-cli.mdx'; | ||
|
|
||
|
|
||
|
|
||
| <Tabs> | ||
| <Tab title="Elementary CLI"> | ||
| <SparkCli /> | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### Have a question? | ||
|
|
||
| We are available | ||
| on [Slack](https://elementary-data.com/community), reach out | ||
| for any kind of help! |
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,19 @@ | ||
| --- | ||
| title: "Trino" | ||
| --- | ||
|
|
||
| import TrinoCli from '/snippets/cli/trino-cli.mdx'; | ||
|
|
||
|
|
||
|
|
||
| <Tabs> | ||
| <Tab title="Elementary CLI"> | ||
| <TrinoCli /> | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### Have a question? | ||
|
|
||
| We are available | ||
| on [Slack](https://elementary-data.com/community), reach out | ||
| for any kind of help! |
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,33 @@ | ||
| ### Athena connection profile | ||
|
|
||
| After installing Elementary's dbt package upon running `dbt deps`, | ||
| you can generate Elementary's profile for usage with `edr` by running the following command within your project: | ||
|
|
||
| ```shell | ||
| dbt run-operation elementary.generate_elementary_cli_profile | ||
| ``` | ||
|
|
||
| The command will print to the terminal a partially filled template of the profile that's needed for `edr` to work. | ||
|
|
||
| ```yml Athena | ||
| ## ATHENA ## | ||
| ## By default, edr expects the profile name 'elementary'. ## | ||
| ## Configure the database and schema of elementary models. ## | ||
| ## Check where 'elementary_test_results' is to find it. ## | ||
|
|
||
| elementary: | ||
| outputs: | ||
| default: | ||
| type: athena | ||
| work_group: [athena workgroup] | ||
| s3_staging_dir: [s3_staging_dir] # Location to store query results & metadata | ||
| s3_data_dir: [s3 data dir] # Location to store table data (if not specified, s3_staging_dir is used) | ||
| region_name: [aws region name] # AWS region, e.g. eu-west-1 | ||
| database: [database name] | ||
| schema: [schema name] # elementary schema, usually [schema name]_elementary | ||
| threads: [number of threads like 8] | ||
| ``` | ||
|
|
||
| We support the same format and connection methods as dbt. Please refer to | ||
| dbt's documentation of [Athena profile](https://docs.getdbt.com/reference/warehouse-setups/athena-setup) for | ||
| further details. |
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,64 @@ | ||
| ### Dremio connection profile | ||
|
|
||
| After installing Elementary's dbt package upon running `dbt deps`, | ||
| you can generate Elementary's profile for usage with `edr` by running the following command within your project: | ||
|
|
||
| ```shell | ||
| dbt run-operation elementary.generate_elementary_cli_profile | ||
| ``` | ||
|
|
||
| The command will print to the terminal a partially filled template of the profile that's needed for `edr` to work. | ||
|
|
||
|
|
||
| <Tabs> | ||
| <Tab title="Dremio Cloud"> | ||
| ```yml | ||
| ## DREMIO CLOUD ## | ||
| ## By default, edr expects the profile name 'elementary'. ## | ||
| ## Configure the database and schema of elementary models. ## | ||
| ## Check where 'elementary_test_results' is to find it. ## | ||
|
|
||
| elementary: | ||
| outputs: | ||
| default: | ||
| type: dremio | ||
| cloud_host: api.dremio.cloud # or api.eu.dremio.cloud for EU | ||
| cloud_project_id: [project ID] | ||
| user: [email address] | ||
| pat: [personal access token] | ||
| use_ssl: true | ||
| object_storage_source: [name] # alias: datalake | ||
| object_storage_path: [path] # alias: root_path | ||
| dremio_space: [name] # alias: database | ||
| dremio_space_folder: [path] # alias: schema, usually [schema]_elementary | ||
| threads: [1 or more] | ||
| ``` | ||
| </Tab> | ||
| <Tab title="Dremio Software"> | ||
| ```yml | ||
| ## DREMIO SOFTWARE ## | ||
| ## By default, edr expects the profile name 'elementary'. ## | ||
| ## Configure the database and schema of elementary models. ## | ||
| ## Check where 'elementary_test_results' is to find it. ## | ||
|
|
||
| elementary: | ||
| outputs: | ||
| default: | ||
| type: dremio | ||
| software_host: [hostname or IP address] | ||
| port: 9047 | ||
| user: [username] | ||
| password: [password] # or use pat: [personal access token] | ||
| use_ssl: [true or false] | ||
| object_storage_source: [name] # alias: datalake | ||
| object_storage_path: [path] # alias: root_path | ||
| dremio_space: [name] # alias: database | ||
| dremio_space_folder: [path] # alias: schema, usually [schema]_elementary | ||
| threads: [1 or more] | ||
| ``` | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| We support the same format and connection methods as dbt. Please refer to | ||
| dbt's documentation of [Dremio profile](https://docs.getdbt.com/docs/core/connect-data-platform/dremio-setup) for | ||
| further details. | ||
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,29 @@ | ||
| ### DuckDB connection profile | ||
|
|
||
| After installing Elementary's dbt package upon running `dbt deps`, | ||
| you can generate Elementary's profile for usage with `edr` by running the following command within your project: | ||
|
|
||
| ```shell | ||
| dbt run-operation elementary.generate_elementary_cli_profile | ||
| ``` | ||
|
|
||
| The command will print to the terminal a partially filled template of the profile that's needed for `edr` to work. | ||
|
|
||
| ```yml DuckDB | ||
| ## DUCKDB ## | ||
| ## By default, edr expects the profile name 'elementary'. ## | ||
| ## Configure the database and schema of elementary models. ## | ||
| ## Check where 'elementary_test_results' is to find it. ## | ||
|
|
||
| elementary: | ||
| outputs: | ||
| default: | ||
| type: duckdb | ||
| path: [path to your .duckdb file] | ||
| schema: [schema name] # elementary schema, usually [schema name]_elementary | ||
| threads: [1 or more] | ||
| ``` | ||
|
|
||
| We support the same format and connection methods as dbt. Please refer to | ||
| dbt's documentation of [DuckDB profile](https://docs.getdbt.com/reference/warehouse-setups/duckdb-setup) for | ||
| further details. |
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,33 @@ | ||
| ### Spark connection profile | ||
|
|
||
| After installing Elementary's dbt package upon running `dbt deps`, | ||
| you can generate Elementary's profile for usage with `edr` by running the following command within your project: | ||
|
|
||
| ```shell | ||
| dbt run-operation elementary.generate_elementary_cli_profile | ||
| ``` | ||
|
|
||
| The command will print to the terminal a partially filled template of the profile that's needed for `edr` to work. | ||
|
|
||
| ```yml Spark | ||
| ## SPARK ## | ||
| ## By default, edr expects the profile name 'elementary'. ## | ||
| ## Configure the database and schema of elementary models. ## | ||
| ## Check where 'elementary_test_results' is to find it. ## | ||
|
|
||
| elementary: | ||
| outputs: | ||
| default: | ||
| type: spark | ||
| method: [thrift, http, or odbc] | ||
| host: [hostname] | ||
| port: [port] | ||
| user: [username] | ||
| schema: [schema name] # elementary schema, usually [schema name]_elementary | ||
| threads: [1 or more] | ||
| # token: [optional, used with http method] | ||
| ``` | ||
|
|
||
| We support the same format and connection methods as dbt. Please refer to | ||
| dbt's documentation of [Spark profile](https://docs.getdbt.com/reference/warehouse-setups/spark-setup) for | ||
| further details. |
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,35 @@ | ||
| ### Trino connection profile | ||
|
|
||
| After installing Elementary's dbt package upon running `dbt deps`, | ||
| you can generate Elementary's profile for usage with `edr` by running the following command within your project: | ||
|
|
||
| ```shell | ||
| dbt run-operation elementary.generate_elementary_cli_profile | ||
| ``` | ||
|
|
||
| The command will print to the terminal a partially filled template of the profile that's needed for `edr` to work. | ||
|
|
||
| ```yml Trino | ||
| ## TRINO ## | ||
| ## By default, edr expects the profile name 'elementary'. ## | ||
| ## Configure the database and schema of elementary models. ## | ||
| ## Check where 'elementary_test_results' is to find it. ## | ||
|
|
||
| elementary: | ||
| outputs: | ||
| default: | ||
| type: trino | ||
| host: [hostname] | ||
| port: [port] | ||
| database: [database name] | ||
| schema: [schema name] # elementary schema, usually [schema name]_elementary | ||
| threads: [1 or more] | ||
| method: [authentication method] # ldap, oauth etc. | ||
| user: [username] | ||
| # password: [optional, used with ldap authentication ] | ||
| # session_properties: [optional, sets Trino session properties used in the connection] | ||
| ``` | ||
|
|
||
| We support the same format and connection methods as dbt. Please refer to | ||
| dbt's documentation of [Trino profile](https://docs.getdbt.com/reference/warehouse-setups/trino-setup) for | ||
| further details. |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should show here either the cloud or the software option
https://docs.getdbt.com/docs/core/connect-data-platform/dremio-setup#profiles
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed — now shows both Dremio Cloud and Dremio Software profile options using tabs, with the correct fields for each (Cloud:
cloud_host,cloud_project_id,pat; Software:software_host,port,password/pat). Also updated the dbt docs link to the current URL.