docs: document Snowflake driver options#153
Open
zeroshade wants to merge 2 commits into
Open
Conversation
Note the relationship between adbc.rpc.result_queue_size and adbc.snowflake.rpc.prefetch_concurrency, and add a Python example showing how to set the option on a statement. Closes #125. Captures apache/arrow-adbc#2328.
Fill in descriptions for the previously type-only options: the login/request/jwt-expire/client timeouts (duration strings), the key-pair-auth private key options, okta_url, keep_session_alive, disable_telemetry, ocsp_fail_open_mode, identity_provider (WIF), config_file, and uri.host/uri.port/uri.protocol. Corrects uri.port to int and documents the OCSP fail-open, port (443), and protocol (https) defaults. Semantics verified against go/driver.go and go/database.go option parsing and the gosnowflake v2 Config fields. Part of #125.
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
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
Completes the option documentation tracked by #125 in
go/docs/snowflake.md.1.
result_queue_size+ example (captures apache/arrow-adbc#2328)adbc.rpc.result_queue_sizeandadbc.snowflake.rpc.prefetch_concurrency(bidirectionally) and added a Pythonset_optionsexample — the missing piece #2328 explicitly asked for.go/connection.go(
defaultStatementQueueSize = 100,defaultPrefetchConcurrency = 5); the"default 5 / 10 workers / queue size 200" figures in #2328 describe the older
upstream Python driver, not this one, so no values changed.
2. Descriptions for the previously type-only options
Filled in descriptions for every option that was listed with only a type:
login_timeout,request_timeout,jwt_expire_timeout,client_timeout) — now documented as Gotime.ParseDurationduration stringswith their precise meaning.
jwt_private_key(file path),jwt_private_key_pkcs8_value(inline PEM),
jwt_private_key_pkcs8_password(passphrase for encrypted keys).okta_url,keep_session_alive,disable_telemetry,ocsp_fail_open_mode,identity_provider(WIF; valuesAWS/AZURE/GCP/OIDC),config_file(client easy-logging config).
uri.host/uri.port/uri.protocol— including correctinguri.porttoint and documenting the OCSP fail-open, port (
443), and protocol(
https) defaults.Semantics were verified against the option parsing in
go/driver.goandgo/database.goand the gosnowflake v2Configfields — not guessed.Testing
Docs-only change to
go/docs/snowflake.md(static MyST section); no code pathsaffected.
Closes #125. Captures apache/arrow-adbc#2328.