Skip to content

Commit 34355d2

Browse files
devin-ai-integration[bot]devin-ai-integration[bot]
authored
docs: add DuckDB, Dremio, Spark, Fabric, SQL Server, and Vertica support to OSS documentation (#2136)
1 parent 36ed16b commit 34355d2

18 files changed

Lines changed: 750 additions & 0 deletions

‎docs/oss/integrations/athena.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Athena"
3+
---
4+
5+
import AthenaCli from '/snippets/cli/athena-cli.mdx';
6+
7+
8+
9+
<Tabs>
10+
<Tab title="Elementary CLI">
11+
<AthenaCli />
12+
</Tab>
13+
</Tabs>
14+
15+
### Have a question?
16+
17+
We are available
18+
on [Slack](https://elementary-data.com/community), reach out
19+
for any kind of help!

‎docs/oss/integrations/duckdb.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "DuckDB"
3+
---
4+
5+
import DuckdbCli from '/snippets/cli/duckdb-cli.mdx';
6+
7+
8+
9+
<Tabs>
10+
<Tab title="Elementary CLI">
11+
<DuckdbCli />
12+
</Tab>
13+
</Tabs>
14+
15+
### Have a question?
16+
17+
We are available
18+
on [Slack](https://elementary-data.com/community), reach out
19+
for any kind of help!

‎docs/oss/integrations/fabric.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Fabric"
3+
---
4+
5+
import FabricCli from '/snippets/cli/fabric-cli.mdx';
6+
7+
8+
9+
<Tabs>
10+
<Tab title="Elementary CLI">
11+
<FabricCli />
12+
</Tab>
13+
</Tabs>
14+
15+
### Have a question?
16+
17+
We are available
18+
on [Slack](https://elementary-data.com/community), reach out
19+
for any kind of help!

‎docs/oss/integrations/spark.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Spark"
3+
---
4+
5+
import SparkCli from '/snippets/cli/spark-cli.mdx';
6+
7+
8+
9+
<Tabs>
10+
<Tab title="Elementary CLI">
11+
<SparkCli />
12+
</Tab>
13+
</Tabs>
14+
15+
### Have a question?
16+
17+
We are available
18+
on [Slack](https://elementary-data.com/community), reach out
19+
for any kind of help!

‎docs/oss/integrations/sqlserver.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "SQL Server"
3+
---
4+
5+
import SqlserverCli from '/snippets/cli/sqlserver-cli.mdx';
6+
7+
8+
9+
<Tabs>
10+
<Tab title="Elementary CLI">
11+
<SqlserverCli />
12+
</Tab>
13+
</Tabs>
14+
15+
### Have a question?
16+
17+
We are available
18+
on [Slack](https://elementary-data.com/community), reach out
19+
for any kind of help!

‎docs/oss/integrations/trino.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Trino"
3+
---
4+
5+
import TrinoCli from '/snippets/cli/trino-cli.mdx';
6+
7+
8+
9+
<Tabs>
10+
<Tab title="Elementary CLI">
11+
<TrinoCli />
12+
</Tab>
13+
</Tabs>
14+
15+
### Have a question?
16+
17+
We are available
18+
on [Slack](https://elementary-data.com/community), reach out
19+
for any kind of help!

‎docs/oss/integrations/vertica.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Vertica"
3+
---
4+
5+
import VerticaCli from '/snippets/cli/vertica-cli.mdx';
6+
7+
8+
9+
<Tabs>
10+
<Tab title="Elementary CLI">
11+
<VerticaCli />
12+
</Tab>
13+
</Tabs>
14+
15+
### Have a question?
16+
17+
We are available
18+
on [Slack](https://elementary-data.com/community), reach out
19+
for any kind of help!

‎docs/snippets/cli/athena-cli.mdx‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
### Athena connection profile
2+
3+
After installing Elementary's dbt package upon running `dbt deps`,
4+
you can generate Elementary's profile for usage with `edr` by running the following command within your project:
5+
6+
```shell
7+
dbt run-operation elementary.generate_elementary_cli_profile
8+
```
9+
10+
The command will print to the terminal a partially filled template of the profile that's needed for `edr` to work.
11+
12+
```yml Athena
13+
## ATHENA ##
14+
## By default, edr expects the profile name 'elementary'. ##
15+
## Configure the database and schema of elementary models. ##
16+
## Check where 'elementary_test_results' is to find it. ##
17+
18+
elementary:
19+
outputs:
20+
default:
21+
type: athena
22+
work_group: [athena workgroup]
23+
s3_staging_dir: [s3_staging_dir] # Location to store query results & metadata
24+
s3_data_dir: [s3 data dir] # Location to store table data (if not specified, s3_staging_dir is used)
25+
region_name: [aws region name] # AWS region, e.g. eu-west-1
26+
database: [database name]
27+
schema: [schema name] # elementary schema, usually [schema name]_elementary
28+
threads: [number of threads like 8]
29+
```
30+
31+
We support the same format and connection methods as dbt. Please refer to
32+
dbt's documentation of [Athena profile](https://docs.getdbt.com/reference/warehouse-setups/athena-setup) for
33+
further details.

‎docs/snippets/cli/dremio-cli.mdx‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
### Dremio connection profile
2+
3+
After installing Elementary's dbt package upon running `dbt deps`,
4+
you can generate Elementary's profile for usage with `edr` by running the following command within your project:
5+
6+
```shell
7+
dbt run-operation elementary.generate_elementary_cli_profile
8+
```
9+
10+
The command will print to the terminal a partially filled template of the profile that's needed for `edr` to work.
11+
12+
13+
<Tabs>
14+
<Tab title="Dremio Cloud">
15+
```yml
16+
## DREMIO CLOUD ##
17+
## By default, edr expects the profile name 'elementary'. ##
18+
## Configure the database and schema of elementary models. ##
19+
## Check where 'elementary_test_results' is to find it. ##
20+
21+
elementary:
22+
outputs:
23+
default:
24+
type: dremio
25+
cloud_host: api.dremio.cloud # or api.eu.dremio.cloud for EU
26+
cloud_project_id: [project ID]
27+
user: [email address]
28+
pat: [personal access token]
29+
use_ssl: true
30+
object_storage_source: [name] # alias: datalake
31+
object_storage_path: [path] # alias: root_path
32+
dremio_space: [name] # alias: database
33+
dremio_space_folder: [path] # alias: schema, usually [schema]_elementary
34+
threads: [1 or more]
35+
```
36+
</Tab>
37+
<Tab title="Dremio Software">
38+
```yml
39+
## DREMIO SOFTWARE ##
40+
## By default, edr expects the profile name 'elementary'. ##
41+
## Configure the database and schema of elementary models. ##
42+
## Check where 'elementary_test_results' is to find it. ##
43+
44+
elementary:
45+
outputs:
46+
default:
47+
type: dremio
48+
software_host: [hostname or IP address]
49+
port: 9047
50+
user: [username]
51+
password: [password] # or use pat: [personal access token]
52+
use_ssl: [true or false]
53+
object_storage_source: [name] # alias: datalake
54+
object_storage_path: [path] # alias: root_path
55+
dremio_space: [name] # alias: database
56+
dremio_space_folder: [path] # alias: schema, usually [schema]_elementary
57+
threads: [1 or more]
58+
```
59+
</Tab>
60+
</Tabs>
61+
62+
We support the same format and connection methods as dbt. Please refer to
63+
dbt's documentation of [Dremio profile](https://docs.getdbt.com/docs/core/connect-data-platform/dremio-setup) for
64+
further details.

‎docs/snippets/cli/duckdb-cli.mdx‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
### DuckDB connection profile
2+
3+
After installing Elementary's dbt package upon running `dbt deps`,
4+
you can generate Elementary's profile for usage with `edr` by running the following command within your project:
5+
6+
```shell
7+
dbt run-operation elementary.generate_elementary_cli_profile
8+
```
9+
10+
The command will print to the terminal a partially filled template of the profile that's needed for `edr` to work.
11+
12+
```yml DuckDB
13+
## DUCKDB ##
14+
## By default, edr expects the profile name 'elementary'. ##
15+
## Configure the database and schema of elementary models. ##
16+
## Check where 'elementary_test_results' is to find it. ##
17+
18+
elementary:
19+
outputs:
20+
default:
21+
type: duckdb
22+
path: [path to your .duckdb file]
23+
schema: [schema name] # elementary schema, usually [schema name]_elementary
24+
threads: [1 or more]
25+
```
26+
27+
We support the same format and connection methods as dbt. Please refer to
28+
dbt's documentation of [DuckDB profile](https://docs.getdbt.com/reference/warehouse-setups/duckdb-setup) for
29+
further details.

0 commit comments

Comments
 (0)