Skip to content

docs: add DuckDB, Dremio, Spark, Fabric, and SQL Server 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.

Sign up for GitHub

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 6 commits into
base: docs
Choose a base branch
from
+657 −0
Open

docs: add DuckDB, Dremio, Spark, Fabric, and SQL Server support to OSS documentation #2136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
85d1d7e
docs: add DuckDB, Dremio, Spark support to OSS documentation
devin-ai-integration[bot] Mar 1, 2026
cd95275
Merge remote-tracking branch 'origin/docs' into devin/ELE-5266-177237…
devin-ai-integration[bot] Mar 3, 2026
2f00505
fix: replace placeholder icons with official DuckDB, Dremio, and Spar…
devin-ai-integration[bot] Mar 3, 2026
679a232
fix: show both Dremio Cloud and Software profile options in CLI docs
devin-ai-integration[bot] Mar 3, 2026
1b6879a
fix: add Dremio Cloud and Software profiles to all-profiles.mdx
devin-ai-integration[bot] Mar 3, 2026
b1656ff
docs: add Fabric and SQL Server OSS adapter documentation
haritamar Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/oss/integrations/athena.mdx
View file
Open in desktop
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!
19 changes: 19 additions & 0 deletions docs/oss/integrations/duckdb.mdx
View file
Open in desktop
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!
19 changes: 19 additions & 0 deletions docs/oss/integrations/fabric.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "Fabric"
---

import FabricCli from '/snippets/cli/fabric-cli.mdx';



<Tabs>
<Tab title="Elementary CLI">
<FabricCli />
</Tab>
</Tabs>

### Have a question?

We are available
on [Slack](https://elementary-data.com/community), reach out
for any kind of help!
19 changes: 19 additions & 0 deletions docs/oss/integrations/spark.mdx
View file
Open in desktop
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!
19 changes: 19 additions & 0 deletions docs/oss/integrations/sqlserver.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "SQL Server"
---

import SqlserverCli from '/snippets/cli/sqlserver-cli.mdx';



<Tabs>
<Tab title="Elementary CLI">
<SqlserverCli />
</Tab>
</Tabs>

### Have a question?

We are available
on [Slack](https://elementary-data.com/community), reach out
for any kind of help!
19 changes: 19 additions & 0 deletions docs/oss/integrations/trino.mdx
View file
Open in desktop
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!
33 changes: 33 additions & 0 deletions docs/snippets/cli/athena-cli.mdx
View file
Open in desktop
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.
64 changes: 64 additions & 0 deletions docs/snippets/cli/dremio-cli.mdx
View file
Open in desktop
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:
Copy link
Collaborator

@haritamar haritamar Mar 3, 2026

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

Copy link
Contributor Author

@devin-ai-integration devin-ai-integration bot Mar 3, 2026

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.

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.
29 changes: 29 additions & 0 deletions docs/snippets/cli/duckdb-cli.mdx
View file
Open in desktop
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.
36 changes: 36 additions & 0 deletions docs/snippets/cli/fabric-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
33 changes: 33 additions & 0 deletions docs/snippets/cli/spark-cli.mdx
View file
Open in desktop
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.
36 changes: 36 additions & 0 deletions docs/snippets/cli/sqlserver-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
35 changes: 35 additions & 0 deletions docs/snippets/cli/trino-cli.mdx
View file
Open in desktop
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.
Loading
Loading