fauna export get 

fauna export get <exportId> [flags]

Get an export by its ID.

By default, the command outputs the export’s information as YAML. To get the information as JSON, use --json.

To use exports, you must:

  • Have an Enterprise plan.

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

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

Positional arguments

<exportId> (Required)

ID of the export to retrieve.

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.

Options
-h, --help

Show help.

--version

Show the Fauna CLI version.

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.

Options
-h, --help

Show help.

--version

Show the Fauna CLI version.

-w, --wait, --watch

Wait for the export to complete or fail before exiting. Polls for the export’s state using an exponential backoff strategy. Use '--max-wait' to set a timeout.

--max-wait <number>

Maximum wait time in minutes. Defaults to 120 minutes.

Examples

# Get an export with an ID of '123456789'.
fauna export get 123456789

# Get an export as JSON.
fauna export get 123456789 \
  --json

# Wait for the export to complete or fail before exiting.
# Waits up to 180 minutes.
fauna export get 123456789 \
  --wait \
  --max-wait 180
\