Skip to content

docs: add query tag documentation to Snowflake and Databricks connectors #2792

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

Open
jacobmarble wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add query tag documentation to Snowflake and Databricks connectors #2792

Show file tree
Hide file tree
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
10 changes: 10 additions & 0 deletions site/docs/reference/Connectors/materialization-connectors/Snowflake.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,16 @@ Available options in Estuary include:
You do not need to explicitly set the [`TIMESTAMP_TYPE_MAPPING` configuration](https://docs.snowflake.com/en/sql-reference/parameters#timestamp-type-mapping) in Snowflake.
However, if you do, the value in Snowflake **must** match the value in Estuary.

## Query Tags

The Snowflake connector automatically sets a [query tag](https://docs.snowflake.com/en/sql-reference/parameters#query-tag) on every session. The tag has the format `materialization_name:<task_name>`, where `<task_name>` is the full name of your Estuary materialization task.

This requires no configuration. You can use query tags to:

* **Monitor queries**: Filter [QUERY_HISTORY](https://docs.snowflake.com/en/sql-reference/functions/query_history) by `QUERY_TAG` to see all queries originating from a specific materialization.
* **Attribute costs**: Break down warehouse costs per materialization task using the query tag in your Snowflake usage reports.
* **Debug issues**: Quickly identify which materialization task generated a particular query.

## Reserved words

Snowflake has a list of reserved words that must be quoted in order to be used as an identifier. Estuary automatically quotes fields that are in the reserved words list. You can find this list in Snowflake's documentation [here](https://docs.snowflake.com/en/sql-reference/reserved-keywords.html) and in the table below.
Expand Down
10 changes: 10 additions & 0 deletions site/docs/reference/Connectors/materialization-connectors/databricks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,16 @@ SET TBLPROPERTIES (
);
```

## Query Tags

The Databricks connector automatically sets a [query tag](https://docs.databricks.com/en/sql/user/queries/query-tags.html) on every session. The tag has the format `materialization_name:<task_name>`, where `<task_name>` is the full name of your Estuary materialization task.

This requires no configuration. You can use query tags to:

* **Monitor queries**: Filter the Databricks [query history](https://docs.databricks.com/en/sql/user/queries/query-history.html) to see all queries originating from a specific materialization.
* **Attribute costs**: Break down warehouse costs per materialization task using query tags.
* **Debug issues**: Quickly identify which materialization task generated a particular query.

## Reserved words

Databricks has a list of reserved words that must be quoted in order to be used as an identifier. Estuary automatically quotes fields that are in the reserved words list. You can find this list in Databricks's documentation [here](https://docs.databricks.com/en/sql/language-manual/sql-ref-reserved-words.html) and in the table below.
Expand Down
Loading