renamed clientId to userAgentHeader in connect args #281
Conversation
This file contains 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
shivam2680
temporarily deployed
to
azure-prod
GitHub Actions
Inactive
shivam2680
requested review from
superdupershant,
yunbodeng-db,
andrefurlan-db,
rcypher-databricks,
jackyhu-db and
benc-db
as code owners
lib/contracts/IDBSQLClient.ts
Outdated
| @@ -30,7 +30,7 @@ export type ConnectionOptions = { | |||
| host: string; | |||
| port?: number; | |||
| path: string; | |||
| clientId?: string; | |||
| userAgentHeader?: string; | |||
There was a problem hiding this comment.
LGTM. The only thing I'd change - maybe use userAgentEntry, like in Python connector
| // Example: | ||
| // - NodejsDatabricksSqlConnector/0.1.8-beta.1 (Node.js 16.13.1; Darwin 21.5.0) | ||
| // UserAgent ::= <ProductName> '/' <ProductVersion> '(' <Comment> ')' | ||
| // ProductName ::= 'NodejsDatabricksSqlConnector' |
There was a problem hiding this comment.
nit : include the where in comment
shivam2680
temporarily deployed
to
azure-prod
GitHub Actions
Inactive
kravets-levko
approved these changes
Feb 19, 2025
jackyhu-db
approved these changes
Feb 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR adds
userAgentHeaderoption in connect call, so users can configure the user agent string generated.Note: clientId arg in
connectoptions is renamed to userAgentHeader. The clientId inOAuthManageroptions exists and corresponds to the Databricks Service Principal clientId.Testing
unit tests