GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — docs: restore getting started and troubleshooting pages by vuanhphung · Pull Request #581 · databricks/databricks-sql-nodejs

Conversation

@vuanhphung

@vuanhphung vuanhphung commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator

docs/readme.md and docs/troubleshooting.md were removed in #248 (released in 1.8.4) as out of date, but the Databricks documentation for the Node.js driver still links to both under "Additional resources", so those links return 404. GitHub redirects the blob/master/... links to main, so restoring the files at the same lowercase paths fixes the links.

The old content described the Hive-era API and a reconnect-on-close recipe that no longer applies, so both pages are rewritten for the current 3.x driver. The getting-started page is a short tour that points to the README, CONNECTION_PARAMETERS.md, and the examples. The troubleshooting page covers DBSQLLogger, the errors you see for common failures on each backend, connection settings, auth, proxies, TLS, timeouts and retries, and the kernel native module. The README now links to both pages.

Every behavior and message the pages document was checked against lib/ and observed against a live warehouse on both Thrift and useKernel: true: invalid token, wrong path, unknown host, SQL errors, STATEMENT_TIMEOUT, half-supplied mTLS, logging, the proxy option with and without auth, and HTTPS_PROXY (ignored by Thrift, honored by Kernel). TLS was checked locally against a server signed by a private CA: default verification fails, and customCaCert or checkServerCertificate: false fixes it on both backends; NODE_EXTRA_CA_CERTS works only on Thrift. socketTimeout was also checked locally. Most of the same checks were repeated against the published 3.0.0. There, Thrift errors expose the SQLSTATE only as error.response.sqlState, which the page notes. The DBSQLLogger directory handling that hasn't been released yet is left out.

Docs only, with no runtime change. npm run lint, type-check, build, and npm test (1527 passing) pass. prettier --check passes for every file in the repo. npm pack --dry-run shows docs/ is still excluded from the package, like the existing docs/TELEMETRY.md.

Fixes #274

This pull request and its description were written by Isaac.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@vuanhphung Isaac
docs: restore getting started and troubleshooting pages
bf1802e
docs/readme.md and docs/troubleshooting.md were removed in c00f72e (#248), but the Databricks documentation still links to them. Restore both paths with content for the current driver (Thrift and the useKernel backend) and link them from the README.

Fixes #274

Signed-off-by: Vu Anh Phung <[email protected]>
Co-authored-by: Isaac <[email protected]>
@vuanhphung
vuanhphung temporarily deployed to azure-prod November 11, 2026 22:56 — with GitHub Actions Inactive
@vuanhphung
vuanhphung temporarily deployed to azure-prod November 11, 2026 22:56 — with GitHub Actions Inactive
@vuanhphung
vuanhphung temporarily deployed to azure-prod November 11, 2026 22:56 — with GitHub Actions Inactive
peco-review-bot[bot]
peco-review-bot Bot approved these changes Nov 11, 2026
View reviewed changes

@peco-review-bot peco-review-bot Bot left a comment

Copy link
Copy Markdown

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No issues identified by the review bot.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

This branch was previously deployed

1 inactive deployment
azure-prod — bf1802e6 Deployed Nov 11, 2026 by vuanhphung via e2e-test (26.12.1, 26_12_1) #1863
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@peco-review-bot peco-review-bot[bot] peco-review-bot[bot] approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs folder deleted in 1.8.4

Uh oh!

There was an error while loading. Please reload this page.

1 participant

@vuanhphung
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.