Skip to content

docs: add details on enabling the push API in DBT documentation #826

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

Closed
klesh wants to merge 1 commit into from
Closed

docs: add details on enabling the push API in DBT documentation #826

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions docs/Plugins/dbt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ description: >
dbt (data build tool) enables analytics engineers to transform data in their warehouses by simply writing select statements. dbt handles turning these select statements into tables and views.
dbt does the T in ELT (Extract, Load, Transform) processes – it doesn’t extract or load data, but it’s extremely good at transforming data that’s already loaded into your warehouse.


The push API is disabled by default. To enable it safely, you must:
- configure `PUSH_API_ALLOWED_TABLES` with the specific non-internal tables that may be written
- send a Bearer API key whose `allowedPath` matches the `/push/...` endpoint you are calling

Internal `_devlake_*` tables are never writable through this endpoint, even if
they are listed in `PUSH_API_ALLOWED_TABLES`.

## User setup<a id="user-setup"></a>
- If you plan to use this product, you need to install some environments first.

Expand Down
Loading