Skip to content

Commit

Permalink
Document new DB naming behavior (#176)
Browse files Browse the repository at this point in the history
Small nit - default db names
  • Loading branch information
apoliakov authored Aug 12, 2024
1 parent 91b876d commit 065ab02
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/api-reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Every field is required unless otherwise specified.
- **port**: Database server port. For local deployment only, not used in DBOS Cloud.
- **username**: Username with which to connect to the database server. For local deployment only, not used in DBOS Cloud.
- **password**: Password with which to connect to the database server. We recommend using an environment variable for this field, instead of plain text. For local deployment only, not used in DBOS Cloud.
- **app_db_name**: Name of the application database.
- **app_db_name**: Name of the application database. Defaults to the app name, with dashes replaced by underscores.
- **sys_db_name** (optional): Name of the system database in which DBOS stores internal state. Defaults to `{app_db_name}_dbos_sys`. For local deployment only, not used in DBOS Cloud.
- **app_db_client** (optional): Client to use for connecting to the application database. Must be one of `knex`, `drizzle`, `typeorm`, or `prisma`. Defaults to `knex`. The client specified here is the one used in [`TransactionContext`](../api-reference/contexts#transactioncontextt).
- **ssl_ca** (optional): If using SSL/TLS to securely connect to a database, path to an SSL root certificate file. Equivalent to the [`sslrootcert`](https://www.postgresql.org/docs/current/libpq-ssl.html) connection parameter in `psql`.
Expand Down
3 changes: 1 addition & 2 deletions docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,7 @@ npx dbos-cloud db provision <database-instance-name> -U <database-username>
This command should print `Database successfully provisioned!` To view your provisioned instance, run `npx dbos-cloud db list`. For more information, see the [database management guide](../cloud-tutorials/database-management.md).

:::info
This instance can host multiple independent databases for different applications.
By default, the "Hello" app uses a database named `hello`. This is configurable in [`dbos-config.yaml`](../api-reference/configuration.md)
This instance can host multiple logical databases for different apps. By default, every logical database has the same name as its app. This is configured in [`dbos-config.yaml`](../api-reference/configuration.md)
:::

### 5. Deploy!
Expand Down

0 comments on commit 065ab02

Please sign in to comment.