`fauna schema status`

Prints the index build status for a staged schema change.

Syntax

fauna schema status [--[no-]color ] [--dir <value>]
[--endpoint <value>] [--environment <value>] [--help]
[--secret <value>] [--timeout <value>] [--url <value>]

Description

fauna schema status prints the index build status for a staged schema change. See Run a staged schema change.

Arguments

None

Options

Option Description

Option	Description
`--[no-]color`	Enables or disables color formatting for the output. Color formatting is enabled by default if the terminal supports it (determined using chalk/supports-color). Use `--no-color` to disable.
`--dir`	A local directory of `.fsl` files. Defaults to the directory specified in `.fauna-project`.
`--endpoint`	Fauna server endpoint.
`--environment`	Environment to use from `.fauna-project`.
`--help`	Help for the command.
`--secret`	Authentication secret. Overrides the secret in `.fauna-shell`. Use a scoped key to interact with a child database using a parent database’s admin key. For example, with a parent database’s admin key secret of `fn123`, you can access a child database by appending the child database name and role: `fn123:childDB:admin`.
`--timeout`	Connection timeout in milliseconds.
`--url`	Database URL. Overrides the `url` in `.fauna-shell`.

--[no-]color

Enables or disables color formatting for the output. Color formatting is enabled by default if the terminal supports it (determined using chalk/supports-color). Use --no-color to disable.

--dir

A local directory of .fsl files. Defaults to the directory specified in .fauna-project.

--endpoint

Fauna server endpoint.

--environment

Environment to use from .fauna-project.

--help

Help for the command.

--secret

Authentication secret. Overrides the secret in .fauna-shell.

Use a scoped key to interact with a child database using a parent database’s admin key.

For example, with a parent database’s admin key secret of fn123, you can access a child database by appending the child database name and role: fn123:childDB:admin.

--timeout

Connection timeout in milliseconds.

--url

Database URL. Overrides the url in .fauna-shell.

Examples

Basic example

To check the status of staged schema:

fauna schema status

The response includes a status for the staged schema and a summary of any staged or local changes:

Connected to endpoint: cloud-us
Staged status: ready
Staged changes:

  * Modifying collection `Customer` at collections.fsl:4:1

(use `fauna schema commit` to commit staged changes)
Local changes:

  * Modifying collection `Customer` at collections.fsl:4:1

(use `fauna schema diff` to display local changes)
(use `fauna schema push` to stage local changes)

Run a staged schema change

You typically use the schema status command as part of a staged schema change.

A staged schema change lets you change one or more collection schema without index downtime due to index builds.

To run a staged schema change, you must use the Fauna CLI or the Fauna Core HTTP API’s Schema endpoints.

You can’t run a staged schema change using FQL schema methods or the Fauna Dashboard.

To run a staged schema change using the Fauna CLI:

Make the desired changes to .fsl files in your schema directory.

You can’t use a staged schema change to delete or rename schema. Instead, delete or rename the schema in a separate unstaged schema change.
Use fauna schema push to stage the schema changes. fauna schema push stages schema changes by default:
```
# Replace 'us' with your preferred region group:
# 'us' (United States), 'eu' (Europe), or `global`.
# Replace 'my_db' with your database's name.
fauna schema push \
  --database us/my_db \
  --dir /path/to/schema/dir
```
A database can have one staged schema change at a time. You can update staged schema using fauna schema push.

When a database has staged schema, any access or updates done using FQL’s schema commands on related system collections interact with the staged schema, not the database’s active schema.

For example, when schema changes are staged, Collection.all() returns Collection documents for the staged collection schema, not the database’s Collection documents.

If a database has staged schema, you can’t edit the database’s active schema using FQL, the Dashboard, or an unstaged schema change. You must first abandon the staged schema change.

Use fauna schema status to check the status of the staged schema:

fauna schema status \
  --database us/my_db

Possible statuses:

Staged status Description

Staged status	Description
`pending`	Changes are being processed. New indexes are still being built.
`ready`	All indexes have been built. Changes are ready to commit.
`failed`	There was an error during the staging process.

pending

Changes are being processed. New indexes are still being built.

ready

All indexes have been built. Changes are ready to commit.

failed

There was an error during the staging process.

When the status is ready, use fauna schema commit to apply the staged schema to the database:
```
fauna schema commit \
  --database us/my_db
```
You can only commit staged schema with a status of ready.

If you no longer wish to apply the staged schema or if the status is failed, use fauna schema abandon to unstage the schema:
```
fauna schema abandon \
  --database us/my_db
```

fauna schema status