From 2e5ceca5db1a68d9aa5bd0794d502c572c355a2c Mon Sep 17 00:00:00 2001 From: Desmond Hui Date: Fri, 20 Oct 2023 07:19:40 -0700 Subject: [PATCH] update to include endpoint configs for LiveQuery --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 5928451..8276e5f 100644 --- a/README.md +++ b/README.md @@ -126,6 +126,22 @@ LiveQuery is now available to be deployed into individual projects. For base fun dbt run -s livequery_models.deploy.quicknode.quicknode_utils__quicknode_utils livequery_models.deploy.quicknode.quicknode_solana_nfts__quicknode_utils --vars '{UPDATE_UDFS_AND_SPS: true}' ``` +### Configuring LiveQuery API endpoints + +Individual projects have the option to point to a different LiveQuery API endpoint. To do so, modify your project's `dbt_projects.yml` to include the additional configurations within the project `vars`. If no configurations are specified, the default endpoints defined in the `livequery_models` package are used. + +Below is a sample configuration. The `API_INTEGRATION` and `EXTERNAL_FUNCTION_URI` should point to the specific resources deployed for your project. The `ROLES` property is a list of Snowflake role names that are granted usage to the LiveQuery functions on deployment. + +``` +config: + # The keys correspond to dbt profiles and are case sensitive + dev: + API_INTEGRATION: AWS_MY_PROJECT_LIVE_QUERY + EXTERNAL_FUNCTION_URI: myproject.api.livequery.com/path-to-endpoint/ + ROLES: + - INTERNAL_DEV +``` + ## Resources * Learn more about dbt [in the docs](https://docs.getdbt.com/docs/introduction)