fauna database list

fauna database list

List top-level or child databases.

To get top-level databases, omit --database and --secret. To get child databases, use --database or --secret to specify the parent database. If using --secret, the parent database is the database to which the secret is scoped.

When using interactive login or an account key, the command outputs the database’s name and path, Region Group identifier and hierarchy. Paths are not available when using a secret.

Flags

Output
--color

Enable color formatting for output. Enabled by default. Use --no-color to disable.

--json

Output results as JSON. This flag doesn’t affect error output.

--quiet

Suppress all log messages except fatal errors. Output only command results. Overrides --verbosity and --verbose-component.

Config
--config <string>

Path to a CLI config file to use. If provided, must specify a profile.

-p, --profile <string>

Profile from the CLI config file. A profile is a group of CLI settings.

Debug
--verbose-component <array>

Components to emit logs for. Overrides --verbosity.

Accepts the following values:

  • argv

  • config

  • creds

  • error

  • fetch

Pass values as a space-separated list. Example: --verbose-component argv config.

--verbosity <number>

Least critical log level to emit. Accepts integers ranging from 1 (fatal) to 5 (debug). Lower values represent more critical logs. Log messages with a level greater than this value are not logged.

API
-u, --user <string>

CLI user to run the command as. You must first log in as the user using fauna login. Defaults to default. See Interactive login.

--local

Use a local Fauna container.

If not otherwise specified, this flag sets:

--url <string>

URL for Core HTTP API requests made by the command. Defaults to https://db.fauna.com.

--secret <string>

Secret used for authentication. Supports scoped keys. The command runs in the database to which the secret is scoped.

If the secret is a key secret with the admin role, you can pass this flag with --database and an optional --role to create and use a scoped key that impersonates a role on a child database. See Scoped keys.

--account-key <string>

Fauna account key used for authentication. If used, you must also provide a --database and an optional --role. See Account key authentication.

Can’t be used with --user or --secret. If --account-key and --user are specified, --user is ignored.

-d, --database <string>

Database, including the region group identifier and hierarchy, to run the command in. Supports shorthand region group identifiers. Separate path components using /. Examples: us/my_db, eu/parent_db/child_db, global/db. Can’t be used with --secret.

If using a local Fauna container, omit the region group.

-r, --role <string>

Role used to run the command. Defaults to admin. Can’t be used with --secret.

Options
-h, --help

Show help.

--version

Show the Fauna CLI version.

--page-size <number>

Maximum number of databases to return. Defaults to 1000.

Examples

# List all top-level databases.
fauna database list

# List all child databases directly
# under the 'us/parent_db' database.
fauna database list \
  --database 'us/parent_db'

# Get all child databases for the database
# scoped to a secret.
fauna database list \
  --secret my-secret

# List all top-level databases and output as JSON.
fauna database list \
  --json

# List the first 10 top-level databases.
fauna database list \
  --page-size 10

Aliases

fauna db list
\