Skip to content

Add missing available options for the client database configuration #2084

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 22, 2024
Merged

Add missing available options for the client database configuration #2084

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55c1d28
Add missing available options for the client database configuration
pwizla Apr 17, 2024
2698ede
Update docusaurus/docs/dev-docs/configurations/database.md
pwizla Apr 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update docusaurus/docs/dev-docs/configurations/database.md 
Co-authored-by: Ben Irvin <[email protected]>
  • Loading branch information
@pwizla @innerdvations
pwizla and innerdvations authored Apr 17, 2024
commit 2698ede9ea83607c935da90d6b3053ad756b39e5
2 changes: 1 addition & 1 deletion docusaurus/docs/dev-docs/configurations/database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The `./config/database.js` (or `./config/database.ts` for TypeScript) accepts 2

| Parameter | Description | Type | Default |
|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------|-----------|---------|
| `client` | Database client to create the connection.<br/>Accepts the following values:<ul><li>For SQLite databases:<ul><li>`sqlite3`</li><li>`vscode/sqlite3`</li><li>`sqlite-legacy`</li><li>`better-sqlite3`</li></ul></li><li>For PostgreSQL databases: `postgres`</li><li>For MySQL databases:<ul><li>`mysql`</li><li>`mysql2` (see [additional details](#alternative-database-driver-packages))</li></ul></li></ul> | `String` | - |
| `client` | Database client to create the connection.<br/>Accepts the following values:<ul><li>For SQLite databases:<ul><li>`sqlite3`</li><li>`better-sqlite3`</li></ul></li><li>For PostgreSQL databases: `postgres`</li><li>For MySQL databases:<ul><li>`mysql`</li><li>`mysql2` (see [additional details](#alternative-database-driver-packages))</li></ul></li></ul> | `String` | - |
| `connection` | Database [connection information](#connection-parameters) | `Object` | - |
| `debug` | Show database exchanges and errors. | `Boolean` | `false` |
| `useNullAsDefault`<br/><br />_Optional, only for SQLite_ | Use `NULL` as a default value | `Boolean` | `true` |
Expand Down