docs: Add YugabyteDB smart driver features to Sequelize documentation #29496
Conversation
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
✅ Deploy Preview for infallible-bardeen-164bc9 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
krishna-yb
force-pushed
the
docs-sequelize-smart-driver
branch
from
16458e6 to
e4670d9
Compare
Contributor
Author
ashetkar
reviewed
Nov 26, 2025
krishna-yb
force-pushed
the
docs-sequelize-smart-driver
branch
3 times, most recently
from
f1b8dfc to
e2fa65a
Compare
Contributor
Author
Contributor
Author
|
Hey @aishwarya24 Most recent sequelize page: link |
ddhodge
reviewed
Dec 1, 2025
| ##### Environment variables | ||
| The following table summarizes the environment variables available for configuring the YugabyteDB node-postgres smart driver: |
Contributor
There was a problem hiding this comment.
@ashetkar These Env variables are common to the driver not just sequelize? Why is this table not here https://docs.yugabyte.com/stable/develop/drivers-orms/nodejs/yugabyte-node-driver/#step-2-set-up-the-database-connection
Contributor
There was a problem hiding this comment.
Yes, it's specific to the driver. @krishna-yb let's add this info on the page linked above.
- Added subsection: Using the YugabyteDB Smart Driver - Explains how to use smart driver with sequelize-yugabytedb - Links to smart-drivers documentation - Shows package.json configuration - Simplified load balance properties section - Environment variables examples - Connection parameters examples - Removed detailed property table for brevity
- Add comprehensive environment variables table to yugabyte-node-driver.md - Include all standard PG env vars (PGHOST, PGPORT, PGDATABASE, PGUSER, PGPASSWORD) - Include YugabyteDB-specific env vars (PGLOADBALANCE, PGTOPOLOGYKEYS, PGYBSERVERSREFRESHINTERVAL) - Add mapping table showing environment variable to connection parameter correspondence - Add code examples showing how to set env vars in Node.js and shell - Update sequelize.md to clarify it shows 'some' not 'all' environment variables - Add cross-reference from Sequelize docs to complete env vars documentation
krishna-yb
force-pushed
the
docs-sequelize-smart-driver
branch
from
f43c5ec to
64a44e5
Compare
- Remove redundant detailed env vars table from yugabyte-node-driver.md - Keep only the mapping table showing env var to parameter correspondence - Add all standard PostgreSQL env vars (PGHOST, PGPORT, PGDATABASE, PGUSER, PGPASSWORD) - Include YugabyteDB-specific env vars (PGLOADBALANCE, PGTOPOLOGYKEYS, PGYBSERVERSREFRESHINTERVAL) - Remove note from yugabyte-node-driver.md (cleaner without it) - Update sequelize.md to link to complete env vars list - Clarify that load balancing env vars are only for @yugabytedb/pg package
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Uh oh!
There was an error while loading. Please reload this page.