Skip to content

Commit a059a81

Browse files
authored
Documentation update (#301)
### Summary Documentation update. ### Description Updated documentation regarding Enterprise Catalog options ### Related Issue #298
1 parent a90ac68 commit a059a81

2 files changed

Lines changed: 29 additions & 17 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ The `dbt-dremio` package contains all of the code enabling dbt to work with [Dre
1212

1313
The dbt-dremio package supports both Dremio Cloud and Dremio Software (versions 22.0 and later).
1414

15-
## dbt-dremio version 1.8.4
15+
## dbt-dremio version 1.9.0
1616

17-
Version 1.8.4 of the dbt-dremio adapter is compatible with dbt-core versions 1.8.*.
17+
Version 1.9.0 of the dbt-dremio adapter is compatible with dbt-core versions 1.9.*.
1818

1919
> Prior to version 1.1.0b, dbt-dremio was created and maintained by [Fabrice Etanchaud](https://github.com/fabrice-etanchaud) on [their GitHub repo](https://github.com/fabrice-etanchaud/dbt-dremio). Code for using Dremio REST APIs was originally authored by [Ryan Murray](https://github.com/rymurr). Contributors in this repo are credited for laying the groundwork and maintaining the adapter till version 1.0.6.5. The dbt-dremio adapter is maintained and distributed by Dremio starting with version 1.1.0b.
2020
2121
## Getting started
2222

2323
- [Install dbt-dremio](https://docs.getdbt.com/reference/warehouse-setups/dremio-setup)
24-
- Version 1.8.0 of dbt-dremio requires dbt-core >= 1.8.*.
24+
- Version 1.9.0 of dbt-dremio requires dbt-core >= 1.9.*.
2525
- Read the [introduction](https://docs.getdbt.com/docs/introduction/) and [viewpoint](https://docs.getdbt.com/docs/about/viewpoint/)
2626

2727
## Join the dbt Community

docs/walkthrough.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@
1212
- [`dbt init` prompts](#dbt-init-prompts)
1313
- [Basics](#basics)
1414
- [Connection Settings and Authentication](#connection-settings-and-authentication)
15-
- [Default View and Table Storage Location](#9-12-default-view-and-table-storage-location)
16-
- [Materializing Tables Location](#materializing-tables-location)
17-
- [Creating Views Location](#creating-views-location)
18-
- [Threads](#13-thread)
15+
- [Storage Options](#storage-options)
16+
- [Option: Use Enterprise Catalog](#option-use-enterprise-catalog-dremio-enterprise-edition-v26)
17+
- [Option: Use Source & Space](#option-use-source--space)
18+
- [Threads](#thread)
1919
- [Customizing Configurations in dbt with Dremio](#customizing-configurations-in-dbt-with-dremio)
2020
- [Configuring Defaults for a Group of Models in `dbt_project.yml`](#configuring-defaults-for-a-group-of-models-in-dbt_projectyml)
2121
- [Configuring an Individual Model with the config Function](#configuring-an-individual-model-with-the-config-function)
@@ -95,16 +95,21 @@ Now we can create a new dbt project using the command `dbt init`, this will be b
9595
- [2] software_with_username_password (if you are self-deploying Dremio like using Docker and want to authenticate using Username/Password)
9696
- [3] software_with_pat (if you are self-deploying Dremio like using Docker and want to authenticate using Personal Access Token which must be generated with Dremio REST API)
9797

98-
#### Connection Settings and Authentication
99-
4. *software host*: The host part of the url for your Dremio instance, if running on your laptop this would be `localhost` or `127.0.0.1`
100-
5. *port*: The port Dremio is running on within the host, which should typically be port `9047`
101-
6. *username*: Your Dremio Username
102-
7. *password*: Your Dremio Password
103-
8. *use_ssl*: Whether to use a SSL connection (choose False if working locally)
98+
#### Storage Options
99+
100+
There are currently **two** possible ways to configure the storage locations for your dbt models in Dremio:
101+
102+
4. Using an Enterprise Catalog, storing both tables and views in the same location.
103+
5. Using Source & Space, storing tables and views, respectively.
104+
105+
##### Option: Use Enterprise Catalog *[Dremio Enterprise Edition v26+]*
104106

105-
#### 9-12: Default View and Table Storage Location
107+
- `enterprise_catalog_namespace`: The name of the enterprise catalog you want to use.
108+
- `enterprise_catalog_folder`: The sub path within the enterprise catalog for storing tables and views.
106109

107-
###### Materializing Tables Location
110+
##### Option: Use Source & Space
111+
112+
###### Source - Materializing Tables Location
108113

109114
- `object_storage_source`: must be a Dremio source where tables can be written (S3, GCP, HDFS, AWS Glue, Polaris, Nessie), if you don't have one of these sources connected to Dremio accept the default `$scratch` option.
110115
- `object_storage_path`: the sub path for your object_storage_source
@@ -114,7 +119,7 @@ These two settings establish where physical tables are created by default, so if
114119
- `object_storage_source`: `nessie`
115120
- `object_storage_path`: `marketing.bronze`
116121

117-
###### Creating Views Location
122+
###### Space - Materializing Views Location
118123

119124
- `dremio_space`: This can be any Dremio Source that can track views (Spaces, Arctic Catalog, Nessie, Dremio Catalog) if you don't have any of these select the default option which will use the users homespace (every user gets a "home" space named after their username on Dremio Self-Deployed)
120125

@@ -125,7 +130,14 @@ If I want views to be create by a default in `default.views` then the values wou
125130
- `dremio_space`: `default`
126131
- `dremio_space_folder`: `views`
127132

128-
#### 13 Thread
133+
#### Connection Settings and Authentication
134+
6. *software host*: The host part of the url for your Dremio instance, if running on your laptop this would be `localhost` or `127.0.0.1`
135+
7. *port*: The port Dremio is running on within the host, which should typically be port `9047`
136+
8. *username*: Your Dremio Username
137+
9. *password*: Your Dremio Password
138+
10. *use_ssl*: Whether to use a SSL connection (choose False if working locally)
139+
140+
#### Thread
129141

130142
Just select the default `1` thread unless you want to use more threads.
131143

0 commit comments

Comments
 (0)