Skip to content

vip export sql

Generate a copy of a database backup for an environment and download it as an archived SQL file.

Usage

vip export sql [options]

Options

OptionDescription
-a, --app Target an application. Accepts a string value for the application name or an integer for the application ID.
-d, --debug Generate verbose output during command execution to help identify or fix errors or bugs.
-e, --env Target an environment. Accepts a string value for the environment type.
-g, --generate-backup Generate a fresh database backup and export a copy of that backup.
-h, --help Retrieve a description, examples, and available options for a (sub)command.
-o, --output Download the file to a specific local directory path with a custom file name.
-v, --version Retrieve the version number of VIP-CLI currently installed on the local machine.

Examples

- Download an archived copy of the most recent database backup for an environment to the current local directory.
$ vip @example-app.develop export sql

- Download an archived copy of the most recent database backup for an environment to a specific file path.
$ vip @example-app.develop export sql --output=~/Desktop/export.sql.gz

- Generate a fresh database backup for an environment and download a copy of that backup.
$ vip @example-app.develop export sql --generate-backup

Last updated: July 11, 2024