-
Notifications
You must be signed in to change notification settings - Fork 99
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make database connection string clearer #3565
base: latest
Are you sure you want to change the base?
Conversation
Signed-off-by: Trang Le <[email protected]>
|
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.
Nice PR. Suggested the tiny change so the string matches the migration docs: https://docs.timescale.com/migrate/latest/pg-dump-and-restore/.
@@ -108,15 +108,15 @@ ORM (object relational mapper) called [Sequelize][sequelize-info]. | |||
1. Compose your connection string variable, using this format: | |||
|
|||
```java | |||
'postgres://user:pass@example.com:5432/dbname' | |||
'postgres://<user>:<pass>@<host>:<port>/<dbname>' |
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.
'postgres://<user>:<pass>@<host>:<port>/<dbname>' | |
'postgres://<user>:<password>@<host>:<port>/<dbname>' |
``` | ||
|
||
1. Open the `index.js` file you created. Require Sequelize in the application, | ||
and declare the connection string: | ||
|
||
```java | ||
const Sequelize = require('sequelize') | ||
const sequelize = new Sequelize('postgres://user:pass@example.com:5432/dbname', | ||
const sequelize = new Sequelize('postgres://<user>:<pass>@<host>:<port>/<dbname>', |
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.
const sequelize = new Sequelize('postgres://<user>:<pass>@<host>:<port>/<dbname>', | |
const sequelize = new Sequelize('postgres://<user>:<password>@<host>:<port>/<dbname>', |
Description
For the connection string to Timescale DB, I enclosed username, password, host and port in angle brackets to indicate to readers that they are not meant to be inserted verbatim and users should add in their own user configs.
Links
N/A
Writing help
For information about style and word usage, see the style guide
Review checklists
Reviewers: use this section to ensure you have checked everything before approving this PR:
Subject matter expert (SME) review checklist
Documentation team review checklist
and have they been implemented?