Statement level query tag in NodeJS connector#339
Open
jiabin-hu wants to merge 5 commits intodatabricks:mainfrom
Open
Statement level query tag in NodeJS connector#339jiabin-hu wants to merge 5 commits intodatabricks:mainfrom
jiabin-hu wants to merge 5 commits intodatabricks:mainfrom
Conversation
4 tasks
vikrantpuppala
added a commit
to databricks/databricks-sql-go
that referenced
this pull request
Apr 6, 2026
## Summary - Adds per-statement query tag support via `driverctx.NewContextWithQueryTags`, allowing users to attach query tags to individual SQL statements through context - Tags are serialized into `TExecuteStatementReq.ConfOverlay["query_tags"]`, consistent with the Python ([#736](databricks/databricks-sql-python#736)) and NodeJS ([#339](databricks/databricks-sql-nodejs#339)) connector implementations - Previously only session-level query tags were supported (set once via `WithSessionParams` at connection time) ## Usage ```go ctx := driverctx.NewContextWithQueryTags(context.Background(), map[string]string{ "team": "data-eng", "app": "etl-pipeline", }) rows, err := db.QueryContext(ctx, "SELECT * FROM table") ``` ## Changes | File | Description | |------|-------------| | `driverctx/ctx.go` | `NewContextWithQueryTags`, `QueryTagsFromContext`, propagation in `NewContextFromBackground` | | `query_tags.go` *(new)* | `SerializeQueryTags` — map to wire format with escaping | | `connection.go` | Read tags from context → serialize → set `ConfOverlay["query_tags"]` | | `driverctx/ctx_test.go` | 5 tests for context helpers | | `query_tags_test.go` *(new)* | 13 tests for serialization (escaping, edge cases) | | `connection_test.go` | 6 integration tests verifying ConfOverlay behavior | | `examples/query_tags/main.go` | Updated with session + statement-level examples | ## Test plan - [x] Unit tests for `SerializeQueryTags` covering nil, empty, single/multi tags, escaping of `\`, `:`, `,` in values and keys - [x] Unit tests for `NewContextWithQueryTags` / `QueryTagsFromContext` including nil context, missing key, timeout preservation, background propagation - [x] Integration tests verifying `ConfOverlay["query_tags"]` is correctly set (or absent) in captured `TExecuteStatementReq` - [ ] Verify existing tests still pass (CI) This pull request was AI-assisted by Isaac. --------- Signed-off-by: Jooho Yeo <jooho.yeo@databricks.com> Co-authored-by: Jooho Yeo <jooho.yeo@databricks.com> Co-authored-by: Vikrant Puppala <vikrant.puppala@databricks.com>
sreekanth-db
reviewed
Apr 9, 2026
| if (value == null) { | ||
| return escapedKey; | ||
| } | ||
| const escapedValue = value.replace(/[\\:,]/g, (c) => `\\${c}`); |
Contributor
There was a problem hiding this comment.
Should we be doing escaping on the client/driver end ? I remember in SEA escaping happens on the server end. Although currently we only support thrift in node driver, lets confirm if server needs escaping in input.
Author
There was a problem hiding this comment.
We should. Thrift layer requires escaped and serialized string as query tags. That's why SEA, built on top of thrift, is doing the escaping. Connectors, which are on top of thrift now, should also do the escaping.
If they were to move to SEA in the future, they can let SEA take care of the escaping, and just pass the dict to SEA.
sreekanth-db
approved these changes
Apr 9, 2026
Contributor
sreekanth-db
left a comment
sreekanth-db
left a comment
There was a problem hiding this comment.
PR description only mentions about unit tests. Have we tested the changes on a real warehouse ?
samikshya-db
had a problem deploying
to
azure-prod
GitHub Actions
Failure
Collaborator
|
Hello @jiabin-hu - Can you confirm Sreekanth's point above and we can merge this? |
Author
Yes, ran the newly added query tags sample code and it worked fine. |
Signed-off-by: Jiabin Hu <jiabin.hu@databricks.com>
Co-authored-by: Isaac Signed-off-by: Jiabin Hu <jiabin.hu@databricks.com>
Signed-off-by: Jiabin Hu <jiabin.hu@databricks.com>
Signed-off-by: Jiabin Hu <jiabin.hu@databricks.com>
Signed-off-by: Jiabin Hu <jiabin.hu@databricks.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
queryTagsoption toExecuteStatementOptionsfor per-statement query taggingserializeQueryTags()utility that converts a key/value dict to a comma-separatedkey:valuestring (matching the Python connector's format), with backslash-escaping for special characters in valuesconfOverlay["query_tags"]onTExecuteStatementReq, consistent with the Python connectorimplementation
Test plan
serializeQueryTagscovering null/empty input, basic serialization, null values, and special character escaping (tests/unit/utils/queryTags.test.ts)executeStatementverifyingconfOverlay.query_tagsis set/unset correctly (tests/unit/DBSQLSession.test.ts)npm testto confirm all unit tests pass