-
Notifications
You must be signed in to change notification settings - Fork 976
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update infer-dbt documentation to fix broken links and add infer-conf…
…igs page (#4636) ## What are you changing in this pull request and why? Found a few broken link son the dbt-infer adapter page. Also added an infer-configs.md page in line with the other adapters. ## Checklist - [X] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. Adding new pages (delete if not applicable): - [X] Add page to `website/sidebars.js` - [X] Provide a unique filename for the new page
- Loading branch information
Showing
3 changed files
with
59 additions
and
6 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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,39 @@ | ||
--- | ||
title: "Infer configurations" | ||
description: "Read this guide to understand how to configure Infer with dbt." | ||
id: "infer-configs" | ||
--- | ||
|
||
|
||
## Authentication | ||
|
||
To connect to Infer from your dbt instance you need to set up a correct profile in your `profiles.yml`. | ||
|
||
The format of this should look like this: | ||
|
||
<File name='~/.dbt/profiles.yml'> | ||
|
||
```yaml | ||
<profile-name>: | ||
target: <target-name> | ||
outputs: | ||
<target-name>: | ||
type: infer | ||
url: "<infer-api-endpoint>" | ||
username: "<infer-api-username>" | ||
apikey: "<infer-apikey>" | ||
data_config: | ||
[configuration for your underlying data warehouse] | ||
``` | ||
</File> | ||
### Description of Infer Profile Fields | ||
| Field | Required | Description | | ||
|------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| `type` | Yes | Must be set to `infer`. This must be included either in `profiles.yml` or in the `dbt_project.yml` file. | | ||
| `url` | Yes | The host name of the Infer server to connect to. Typically this is `https://app.getinfer.io`. | | ||
| `username` | Yes | Your Infer username - the one you use to login. | | ||
| `apikey` | Yes | Your Infer api key. | | ||
| `data_config` | Yes | The configuration for your underlying data warehouse. The format of this follows the format of the configuration for your data warehouse adapter. | |
This file contains 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