Skip to content

Commit

Permalink
[#8][#9][#4] Update README and try to address one dependabot alert (#12)
Browse files Browse the repository at this point in the history
* [#8][#9] Clarify use of decodable profiles in the README

* Clarify deletion of streams on changes in the README

* [#4] Document limitations around connectors

* Fix this dependabot alert https://github.com/decodableco/dbt-decodable/security/dependabot/1
  • Loading branch information
rmetzger committed Mar 28, 2023
1 parent c8d718d commit 50d8286
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ dbt-decodable: # this name must match the 'profile' from dbt_project.yml
dbt run
```

Note that this dbt adapter ignores the `active-profile` setting in `~/.decodable/config`. You must put the decodable profile you want to use
in the `~/.dbt/profiles.yml` file into the `profile_name` setting.
The adapter does not support a custom decodable `base-url` (e.g. for local development or proxies).

## Configuring your profile

Profiles in dbt describe a set of configurations specific to a connection with the underlying data warehouse. Each dbt project should have a corresponding profile (though profiles can be reused for different project). Within a profile, multiple targets can be described to further control dbt's behavior. For example, it's very common to have a `dev` target for development and a `prod` target for production related configurations.
Expand Down Expand Up @@ -87,7 +91,10 @@ To materialize your models simply run the [`dbt run`](https://docs.getdbt.com/re

3. Activate the pipeline.

By default, the adapter will not tear down and recreate the model on Decodable if no changes to the model have been detected. Invoking dbt with the `--full-refresh` flag set, or setting that configuration option for a specific model will cause the corresponding resources on Decodable to be destroyed and built from scratch. See the [docs](https://docs.getdbt.com/reference/resource-configs/full_refresh) for more information on using this option.
By default, the adapter will not tear down and recreate the model on Decodable if no changes to the model have been detected. However, if changes
to a decodable stream have been detected, it will be deleted and recreated. We recommend configuring a `local_namespace` for dbt-managed
resources to prevent accidential deletion of streams.
Invoking dbt with the `--full-refresh` flag set, or setting that configuration option for a specific model will cause the corresponding resources on Decodable to be destroyed and built from scratch. See the [docs](https://docs.getdbt.com/reference/resource-configs/full_refresh) for more information on using this option.

### Custom model configuration

Expand Down Expand Up @@ -181,6 +188,10 @@ Delete all Decodable entities resulting from the materialization of the project'
If the `list` arg is provided, the command only considers the listed resources. Otherwise, it deletes all entities associated with the project. <br>
The `models`, `seeds` and `tests` arguments specify whether those resource types should be included in the cleanup. Note that cleanup does nothing for tests that have not been materialized.

## Known limitations

The dbt decodable adapter does not allow managing decodable connectors via dbt. You can only create streams and pipelines with dbt.

## Contributions

Contributions to this repository are more than welcome.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ ipdb = "*"
pip-tools = "*"
pre-commit = "*"
pyright = ">=1.1"
pytest = ">=7.0"
pytest = ">=7.2"
pytest-dotenv = "*"
pytest-logbook = "*"
pytest-csv = "*"
Expand Down

0 comments on commit 50d8286

Please sign in to comment.