Skip to main content

export

Addedv0.1.x

This operation exports a backup to external storage.

Description​

In Zilliz Cloud, a backup is a copy of your data that enables you to restore the entire cluster or specific collections in the event of data loss or system failure.

You can export backup files to an integrated storage service identified by its integration ID. This operation is asynchronous and will create a job. You can run zilliz job describe to obtain the progress of the job.

📘Notes

This feature is available only to Dedicated clusters.

Usage​

zilliz backup export
--cluster-id <value>
--backup-id <value>
--integration-id <value>
[--directory <value>]
[--output <value>]
[--query <value>]
[--no-header]

OPTIONS:

  • --cluster-id (string) -

    [REQUIRED]

    Indicates a cluster ID, which is similar to inxx-xxxxx.

    If a cluster is configured using zilliz context set, it automatically applies if this option is left unconfigured.

  • --backup-id (string) -

    [REQUIRED]

    Indicates a backup ID, which is similar to backupx-xxxxx.

  • --integration-id (string) -

    [REQUIRED]

    Indicates a storage integration ID, which is similar to integ-xxxxx.

  • --directory (string) -

    Indicates the target directory in external storage.

  • --output, -o (string) -

    Indicates the output format. Possible values:

    • json,

    • table,

    • text,

    • yaml,

    • csv.

  • --no-header (boolean) -

    Indicates whether to omit the header row when output is set to table or csv.

  • --query, -q (string) -

    Indicates a JMESPath expression to filter output.

Example​

zilliz backup export --cluster-id in01-xxxx \
--backup-id backup-xxxx \
--integration-id integ-xxxx