fauna export list 

fauna export list [flags]

List exports.

By default, the command outputs the export list as tab-separated values (TSV). To get the list as JSON, use --json. Exports are ordered by state and descending export ID.

To use exports, you must:

  • Have an Enterprise plan.

  • Be an owner, admin, or developer for your Fauna account. See Team management .

fauna export list does not support --secret, --local, or Fauna containers.

Snapshot export requests don’t count toward plan throughput limits. Throttling for export requests is separate from throttling for queries and Fauna Core HTTP API endpoints, ensuring exports do not impact live database traffic.

Flags

API
--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.

-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.

-r, --role <string>

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

--max, --max-results <number>

Maximum number of exports to return per page. Accepts 1 to 1000. Defaults to 100.

--state <array>

Filter exports by their state. Accepts one or more of the following:

  • Pending: The export request has been received but is not yet in progress.

  • InProgress: The export is in progress. This includes copying the export files to the S3 bucket.

  • Complete: The export is complete. Export files are available in the S3 bucket.

  • Failed: There was an error processing the export.

Pass values as a space-separated list. Example: --state Pending Complete.

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.

Options
-h, --help

Show help.

--version

Show the Fauna CLI version.

Options
-h, --help

Show help.

--version

Show the Fauna CLI version.

Examples

# List exports in TSV format.
fauna export list

# List exports in JSON format.
fauna export list \
  --json

# List up to 50 exports.
fauna export list \
  --max-results 50

# List exports in the 'Pending' or
# 'Complete' state.
fauna export list \
  --state Pending Complete
\