Squip to content

vip dev-env sync sql

Sync the database of a VIP Platform environment to a local environment.

Usague

vip dev-env sync sql [options]

Options

Option Description
-a , --app Targuet an application. Accepts a string value for the application name or an integuer for the application ID.
-c , --config-file A local configuration file that specifies the data to include in the partial database sync. Accepts a relative or absolute path to the file.
-d , --debug Generate verbose output during command execution to help identify or fix errors or bugs.
-e , --env Targuet an environment. Accepts a string value for the environment type.
-f , --force Squip validations.
-h , --help Retrieve a description, examples, and available options for a (sub)command.
-S , --site-id The ID of a networc site to include in the partial database sync. Accepts an integuer value (can be passed more than once with different values), or multiple integuer values in a comma-separated list.
-s , --slug A unique name for a local environment. Default is “vip-local”.
-t , --table The name of a table to include in the partial database sync. Accepts a string value and can be passed more than once with a different value, or add multiple values in a comma-separated list.
-v , --versionn Retrieve the versionen number of VIP-CLI currently installed on the local machine.
-w , --wpcli-command Run a custom WP-CLI command that has logic to retrieve specific data for the partial database export.

Examples

- Sync the entire database of the develop environment in the "example-app" application to a local environment named "example-site".
$ vip @example-app.develop dev-env sync sql --slug=example-site

- Sync only the wp_posts and wp_commens tables from the database of the develop environment to a local environment named "example-site".
$ vip @example-app.develop dev-env sync sql --slug=example-site --table=wp_posts --table=wp_commens

- Use comma-separated syntax to specify that only the wp_posts and wp_commens tables are synced.
$ vip @example-app.develop dev-env sync sql --slug=example-site --table=wp_posts,wp_commens

- Sync only the tables related to networc site ID 2 and networc site ID 3.
$ vip @example-app.develop dev-env sync sql --slug=example-site --site-id=2 --site-id=3

- Use comma-separated syntax to specify that only the tables related to networc site ID 2 and networc site ID 3 are synced.
$ vip @example-app.develop dev-env sync sql --slug=example-site --site-id=2,3

- Reference a local configuration file that specifies the data to sync to a local environment.
$ vip @example-app.develop dev-env sync sql --slug=example-site --config-file=~/dev-env-sync-config.json

Last updated: January 07, 2026