Skip to content

CEXT-5659 updated readme with new region behavior #33

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
nofuss merged 2 commits into from
Feb 3, 2026
+44 −39
Merged

CEXT-5659 updated readme with new region behavior #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
771eac6
updated readme with new region behavior
nofuss Jan 28, 2026
15c0ca0
corrected region documentation, again
nofuss Feb 2, 2026
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
81 changes: 43 additions & 38 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,10 @@ EXAMPLES

# Database Commands

## A Note on Regions

> Note: All workspace databases have to be provisioned in a specific region, and all database commands must be executed in that same region. If set in the `app.config.yaml` application manifest, that region will be used. If not, it will first fall back to what is set in the --region flag, followed by the AIO_DB_REGION environment variable, and finally to the default `amer` region. See [Getting Started with Database Storage](https://developer.adobe.com/app-builder/docs/guides/app_builder_guides/storage/database) for more details.

## Collection Management

> Note: The commands under `aio app db collection <command>` are also available as `aio app db col <command>` shorthand aliases.
Expand All @@ -247,8 +251,9 @@ FLAGS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.


DESCRIPTION
Get the list of collections in your App Builder database
Expand Down Expand Up @@ -283,8 +288,8 @@ FLAGS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Create a new collection in the database
Expand Down Expand Up @@ -315,8 +320,8 @@ ARGUMENTS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Drop a collection from the database
Expand Down Expand Up @@ -346,8 +351,8 @@ ARGUMENTS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Rename a collection in the database
Expand Down Expand Up @@ -376,8 +381,8 @@ ARGUMENTS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Get statistics for a collection in the database
Expand Down Expand Up @@ -414,8 +419,8 @@ FLAGS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Insert one or more documents into a collection
Expand Down Expand Up @@ -447,8 +452,8 @@ ARGUMENTS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Delete a single document from a collection
Expand Down Expand Up @@ -484,8 +489,8 @@ FLAGS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Find documents in a collection based on filter criteria.
Expand Down Expand Up @@ -522,8 +527,8 @@ FLAGS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Update document(s) in a collection
Expand Down Expand Up @@ -559,8 +564,8 @@ FLAGS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Replace a single document in a collection
Expand Down Expand Up @@ -592,8 +597,8 @@ ARGUMENTS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Count documents in a collection
Expand Down Expand Up @@ -637,8 +642,8 @@ REQUIRES AT LEAST ONE OF THE INDEX DEFINITION FLAGS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Create a new index on a collection in the database
Expand Down Expand Up @@ -676,8 +681,8 @@ ARGUMENTS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Drop an index from a collection in the database
Expand Down Expand Up @@ -706,8 +711,8 @@ ARGUMENTS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Get the list of indexes from a collection in the database
Expand Down Expand Up @@ -735,8 +740,8 @@ USAGE

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Test connectivity to your App Builder database
Expand All @@ -760,8 +765,8 @@ FLAGS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Provision a new database for your App Builder application
Expand Down Expand Up @@ -789,8 +794,8 @@ FLAGS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Delete the database for your App Builder application (non-production only)
Expand All @@ -816,8 +821,8 @@ FLAGS

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Check the provisioning status of your App Builder database
Expand All @@ -840,8 +845,8 @@ USAGE

GLOBAL FLAGS
--json Format output as json.
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or 'amer' if neither is set.
<options: amer|emea|apac>
--region=<value> Database region. Defaults to 'AIO_DB_REGION' environment variable or `amer` if neither is set.
Any database region set in 'app.config.yaml' takes precedence over all of these.

DESCRIPTION
Get statistics about your App Builder database
Expand Down
2 changes: 1 addition & 1 deletion src/DBBaseCommand.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ DBBaseCommand.flags = {
helpGroup: 'GLOBAL'
},
region: Flags.string({
description: `Database region. Defaults to 'AIO_DB_REGION' environment variable or '${DEFAULT_REGION}' if neither is set.\n<options: ${AVAILABLE_REGIONS.prod.join('|')}>`,
description: `Database region. Defaults to 'AIO_DB_REGION' environment variable or '${DEFAULT_REGION}' if neither is set. Any database region set in 'app.config.yaml' takes precedence over all of these.\n<options: ${AVAILABLE_REGIONS.prod.join('|')}>`,
required: false,
helpGroup: 'GLOBAL'
// Don't set default here to let it load from the environment var if not passed as a flag
Expand Down