From 85d1d7eda8b7458a5060111d85d64b5e3970b9a8 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Sun, 1 Mar 2026 14:36:51 +0000 Subject: [PATCH 1/5] docs: add DuckDB, Dremio, Spark support to OSS documentation - install-cli.mdx: add pip install lines for duckdb, dremio, spark - all-profiles.mdx: add DuckDB, Dremio, Spark profile templates - adapters-cards.mdx: add DuckDB, Dremio, Spark adapter cards - CLI snippets: create duckdb-cli, dremio-cli, spark-cli, athena-cli, trino-cli - OSS integration pages: create duckdb, spark, athena, trino pages Co-Authored-By: Itamar Hartstein --- docs/oss/integrations/athena.mdx | 19 +++++++++ docs/oss/integrations/duckdb.mdx | 19 +++++++++ docs/oss/integrations/spark.mdx | 19 +++++++++ docs/oss/integrations/trino.mdx | 19 +++++++++ docs/snippets/cli/athena-cli.mdx | 33 +++++++++++++++ docs/snippets/cli/dremio-cli.mdx | 35 ++++++++++++++++ docs/snippets/cli/duckdb-cli.mdx | 29 +++++++++++++ docs/snippets/cli/spark-cli.mdx | 33 +++++++++++++++ docs/snippets/cli/trino-cli.mdx | 35 ++++++++++++++++ docs/snippets/install-cli.mdx | 3 ++ docs/snippets/oss/adapters-cards.mdx | 44 ++++++++++++++++++++ docs/snippets/profiles/all-profiles.mdx | 55 +++++++++++++++++++++++++ 12 files changed, 343 insertions(+) create mode 100644 docs/oss/integrations/athena.mdx create mode 100644 docs/oss/integrations/duckdb.mdx create mode 100644 docs/oss/integrations/spark.mdx create mode 100644 docs/oss/integrations/trino.mdx create mode 100644 docs/snippets/cli/athena-cli.mdx create mode 100644 docs/snippets/cli/dremio-cli.mdx create mode 100644 docs/snippets/cli/duckdb-cli.mdx create mode 100644 docs/snippets/cli/spark-cli.mdx create mode 100644 docs/snippets/cli/trino-cli.mdx diff --git a/docs/oss/integrations/athena.mdx b/docs/oss/integrations/athena.mdx new file mode 100644 index 000000000..b015c3517 --- /dev/null +++ b/docs/oss/integrations/athena.mdx @@ -0,0 +1,19 @@ +--- +title: "Athena" +--- + +import AthenaCli from '/snippets/cli/athena-cli.mdx'; + + + + + + + + + +### Have a question? + +We are available +on [Slack](https://elementary-data.com/community), reach out +for any kind of help! diff --git a/docs/oss/integrations/duckdb.mdx b/docs/oss/integrations/duckdb.mdx new file mode 100644 index 000000000..97ccdb2cd --- /dev/null +++ b/docs/oss/integrations/duckdb.mdx @@ -0,0 +1,19 @@ +--- +title: "DuckDB" +--- + +import DuckdbCli from '/snippets/cli/duckdb-cli.mdx'; + + + + + + + + + +### Have a question? + +We are available +on [Slack](https://elementary-data.com/community), reach out +for any kind of help! diff --git a/docs/oss/integrations/spark.mdx b/docs/oss/integrations/spark.mdx new file mode 100644 index 000000000..f8e09dcd9 --- /dev/null +++ b/docs/oss/integrations/spark.mdx @@ -0,0 +1,19 @@ +--- +title: "Spark" +--- + +import SparkCli from '/snippets/cli/spark-cli.mdx'; + + + + + + + + + +### Have a question? + +We are available +on [Slack](https://elementary-data.com/community), reach out +for any kind of help! diff --git a/docs/oss/integrations/trino.mdx b/docs/oss/integrations/trino.mdx new file mode 100644 index 000000000..5ff62e7c6 --- /dev/null +++ b/docs/oss/integrations/trino.mdx @@ -0,0 +1,19 @@ +--- +title: "Trino" +--- + +import TrinoCli from '/snippets/cli/trino-cli.mdx'; + + + + + + + + + +### Have a question? + +We are available +on [Slack](https://elementary-data.com/community), reach out +for any kind of help! diff --git a/docs/snippets/cli/athena-cli.mdx b/docs/snippets/cli/athena-cli.mdx new file mode 100644 index 000000000..1a77eace7 --- /dev/null +++ b/docs/snippets/cli/athena-cli.mdx @@ -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. diff --git a/docs/snippets/cli/dremio-cli.mdx b/docs/snippets/cli/dremio-cli.mdx new file mode 100644 index 000000000..3b7b30082 --- /dev/null +++ b/docs/snippets/cli/dremio-cli.mdx @@ -0,0 +1,35 @@ +### 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. + +```yml Dremio +## DREMIO ## +## 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] + port: [port] + user: [username] + password: [password] + use_ssl: [true or false] + datalake: [datalake source name] + database: [database name] + 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 [Dremio profile](https://docs.getdbt.com/reference/warehouse-setups/dremio-setup) for +further details. diff --git a/docs/snippets/cli/duckdb-cli.mdx b/docs/snippets/cli/duckdb-cli.mdx new file mode 100644 index 000000000..0db80b0be --- /dev/null +++ b/docs/snippets/cli/duckdb-cli.mdx @@ -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. diff --git a/docs/snippets/cli/spark-cli.mdx b/docs/snippets/cli/spark-cli.mdx new file mode 100644 index 000000000..af871ce9c --- /dev/null +++ b/docs/snippets/cli/spark-cli.mdx @@ -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. diff --git a/docs/snippets/cli/trino-cli.mdx b/docs/snippets/cli/trino-cli.mdx new file mode 100644 index 000000000..82d9da22a --- /dev/null +++ b/docs/snippets/cli/trino-cli.mdx @@ -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. diff --git a/docs/snippets/install-cli.mdx b/docs/snippets/install-cli.mdx index 550a69c1b..78259b8ab 100644 --- a/docs/snippets/install-cli.mdx +++ b/docs/snippets/install-cli.mdx @@ -16,6 +16,9 @@ pip install 'elementary-data[databricks]' pip install 'elementary-data[athena]' pip install 'elementary-data[trino]' pip install 'elementary-data[clickhouse]' +pip install 'elementary-data[duckdb]' +pip install 'elementary-data[dremio]' +pip install 'elementary-data[spark]' ## Postgres doesn't require this step ``` diff --git a/docs/snippets/oss/adapters-cards.mdx b/docs/snippets/oss/adapters-cards.mdx index b3031b163..8d60e02c6 100644 --- a/docs/snippets/oss/adapters-cards.mdx +++ b/docs/snippets/oss/adapters-cards.mdx @@ -342,6 +342,50 @@ } > + + + + + + + } + > + + + D + + } + > + + + + + } + > From 2f00505275280b991851ae5fe99e15e512908621 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Tue, 3 Mar 2026 22:41:32 +0000 Subject: [PATCH 2/5] fix: replace placeholder icons with official DuckDB, Dremio, and Spark brand logos Co-Authored-By: Itamar Hartstein --- docs/snippets/oss/adapters-cards.mdx | 100 ++++++++++++++++++++++----- 1 file changed, 83 insertions(+), 17 deletions(-) diff --git a/docs/snippets/oss/adapters-cards.mdx b/docs/snippets/oss/adapters-cards.mdx index 8d60e02c6..4f12851a9 100644 --- a/docs/snippets/oss/adapters-cards.mdx +++ b/docs/snippets/oss/adapters-cards.mdx @@ -346,15 +346,24 @@ title="dbt-duckdb" icon={ - - - - + + + } > @@ -362,13 +371,65 @@ title="dbt-dremio" icon={ - - D + + + + + + + + + + + + + + + + + + } > @@ -376,13 +437,18 @@ title="dbt-spark" icon={ - - + + + } > From 679a2322e45b33ab3f48dad93d38f0a6582fac98 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Tue, 3 Mar 2026 22:43:45 +0000 Subject: [PATCH 3/5] fix: show both Dremio Cloud and Software profile options in CLI docs Co-Authored-By: Itamar Hartstein --- docs/snippets/cli/dremio-cli.mdx | 47 ++++++++++++++++++++++++++------ 1 file changed, 38 insertions(+), 9 deletions(-) diff --git a/docs/snippets/cli/dremio-cli.mdx b/docs/snippets/cli/dremio-cli.mdx index 3b7b30082..a34a793bb 100644 --- a/docs/snippets/cli/dremio-cli.mdx +++ b/docs/snippets/cli/dremio-cli.mdx @@ -9,8 +9,34 @@ 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 Dremio -## DREMIO ## + + + +```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] +``` + + +```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. ## @@ -19,17 +45,20 @@ elementary: outputs: default: type: dremio - software_host: [hostname] - port: [port] + software_host: [hostname or IP address] + port: 9047 user: [username] - password: [password] + password: [password] # or use pat: [personal access token] use_ssl: [true or false] - datalake: [datalake source name] - database: [database name] - schema: [schema name] # elementary schema, usually [schema name]_elementary + 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] ``` + + We support the same format and connection methods as dbt. Please refer to -dbt's documentation of [Dremio profile](https://docs.getdbt.com/reference/warehouse-setups/dremio-setup) for +dbt's documentation of [Dremio profile](https://docs.getdbt.com/docs/core/connect-data-platform/dremio-setup) for further details. From 1b6879a30be654a9a5dad5a854207ec13e847a1a Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Tue, 3 Mar 2026 22:49:17 +0000 Subject: [PATCH 4/5] fix: add Dremio Cloud and Software profiles to all-profiles.mdx Co-Authored-By: Itamar Hartstein --- docs/snippets/profiles/all-profiles.mdx | 30 ++++++++++++++++++++----- 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/snippets/profiles/all-profiles.mdx b/docs/snippets/profiles/all-profiles.mdx index 2a07b5cc2..9f727875f 100644 --- a/docs/snippets/profiles/all-profiles.mdx +++ b/docs/snippets/profiles/all-profiles.mdx @@ -198,18 +198,36 @@ elementary: ## Configure the database and schema of elementary models. ## ## Check where 'elementary_test_results' is to find it. ## +## -- Dremio Cloud -- ## elementary: outputs: default: type: dremio - software_host: [hostname] - port: [port] + 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] + +## -- Dremio Software -- ## +elementary: + outputs: + default: + type: dremio + software_host: [hostname or IP address] + port: 9047 user: [username] - password: [password] + password: [password] # or use pat: [personal access token] use_ssl: [true or false] - datalake: [datalake source name] - database: [database name] - schema: [schema name] # elementary schema, usually [schema name]_elementary + 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] ``` From b1656fff097c7ba945b8d1821aea21f21b57e3f2 Mon Sep 17 00:00:00 2001 From: Itamar Hartstein Date: Mon, 9 Mar 2026 02:18:47 +0200 Subject: [PATCH 5/5] docs: add Fabric and SQL Server OSS adapter documentation Add integration pages, CLI profile snippets, all-profiles entries, and adapter cards for the newly supported dbt-fabric and dbt-sqlserver adapters. Co-Authored-By: Claude Opus 4.6 --- docs/oss/integrations/fabric.mdx | 19 ++++++++++ docs/oss/integrations/sqlserver.mdx | 19 ++++++++++ docs/snippets/cli/fabric-cli.mdx | 36 +++++++++++++++++++ docs/snippets/cli/sqlserver-cli.mdx | 36 +++++++++++++++++++ docs/snippets/oss/adapters-cards.mdx | 47 +++++++++++++++++++++++++ docs/snippets/profiles/all-profiles.mdx | 44 +++++++++++++++++++++++ 6 files changed, 201 insertions(+) create mode 100644 docs/oss/integrations/fabric.mdx create mode 100644 docs/oss/integrations/sqlserver.mdx create mode 100644 docs/snippets/cli/fabric-cli.mdx create mode 100644 docs/snippets/cli/sqlserver-cli.mdx diff --git a/docs/oss/integrations/fabric.mdx b/docs/oss/integrations/fabric.mdx new file mode 100644 index 000000000..0fabaf72a --- /dev/null +++ b/docs/oss/integrations/fabric.mdx @@ -0,0 +1,19 @@ +--- +title: "Fabric" +--- + +import FabricCli from '/snippets/cli/fabric-cli.mdx'; + + + + + + + + + +### Have a question? + +We are available +on [Slack](https://elementary-data.com/community), reach out +for any kind of help! diff --git a/docs/oss/integrations/sqlserver.mdx b/docs/oss/integrations/sqlserver.mdx new file mode 100644 index 000000000..a836b7070 --- /dev/null +++ b/docs/oss/integrations/sqlserver.mdx @@ -0,0 +1,19 @@ +--- +title: "SQL Server" +--- + +import SqlserverCli from '/snippets/cli/sqlserver-cli.mdx'; + + + + + + + + + +### Have a question? + +We are available +on [Slack](https://elementary-data.com/community), reach out +for any kind of help! diff --git a/docs/snippets/cli/fabric-cli.mdx b/docs/snippets/cli/fabric-cli.mdx new file mode 100644 index 000000000..69bb48817 --- /dev/null +++ b/docs/snippets/cli/fabric-cli.mdx @@ -0,0 +1,36 @@ +### Fabric 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 Fabric +## FABRIC ## +## 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: fabric + driver: ODBC Driver 18 for SQL Server + server: [hostname] + port: 1433 + database: [database name] + schema: [schema name] # elementary schema, usually [schema name]_elementary + authentication: ActiveDirectoryServicePrincipal + tenant_id: [tenant_id] + client_id: [client_id] + client_secret: [client_secret] + threads: [1 or more] +``` + +We support the same format and connection methods as dbt. Please refer to +dbt's documentation of [Fabric profile](https://docs.getdbt.com/docs/core/connect-data-platform/fabric-setup) for +further details. diff --git a/docs/snippets/cli/sqlserver-cli.mdx b/docs/snippets/cli/sqlserver-cli.mdx new file mode 100644 index 000000000..502bfbe1d --- /dev/null +++ b/docs/snippets/cli/sqlserver-cli.mdx @@ -0,0 +1,36 @@ +### SQL Server 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 SQL Server +## SQL SERVER ## +## 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: sqlserver + driver: ODBC Driver 18 for SQL Server + server: [hostname] + port: 1433 + database: [database name] + schema: [schema name] # elementary schema, usually [schema name]_elementary + user: [username] + password: [password] + threads: [1 or more] + # encrypt: true # default true in dbt-sqlserver >= 1.2.0 + # trust_cert: false +``` + +We support the same format and connection methods as dbt. Please refer to +dbt's documentation of [SQL Server profile](https://docs.getdbt.com/docs/core/connect-data-platform/mssql-setup) for +further details. diff --git a/docs/snippets/oss/adapters-cards.mdx b/docs/snippets/oss/adapters-cards.mdx index 4f12851a9..4138cc91d 100644 --- a/docs/snippets/oss/adapters-cards.mdx +++ b/docs/snippets/oss/adapters-cards.mdx @@ -452,6 +452,53 @@ } > + + + + + + + + + + + + + + + + + + + + + + + } + > + + + + } + > = 1.2.0 + # trust_cert: false +``` +