Metaplay Docs

Appearance

metaplay database export-snapshot

Export database snapshot from an environment

metaplay database export-snapshot [ENVIRONMENT] [OUTPUT_FILE] [flags] ​

Export a database snapshot from the specified environment into a file.

DISCLAIMER: This operation is not a real backup and is intended for ad hoc database exports only. This operation should only be used for relatively small databases as it copies the entire database to the machine running the CLI.

The generated snapshot is a zip file containing metadata about the snapshot and a compressed SQL dump for each shard, generated by mariadb-dump. The format of the snapshot is subject to change in the future.

This command starts a temporary debug pod and runs mariadb-dump inside it, connects to the read-only replica of each shard of the database and creates a complete snapshot.

WARNING: It is DANGEROUS to export a database while a game server is deployed. When exporting a database that is under load, it is possible for the database server's purge queue to start growing unboundedly. Do not use the --force on a database with non-trivial load on it!

Expected arguments:

  • ENVIRONMENT -- Target environment name or id, eg, 'lovely-wombats-build-nimbly'.
  • OUTPUT_FILE (optional) -- Output file path for the database snapshot. Defaults to 'database-snapshot-${env}-${timestamp}.mdb' if not specified.

Related commands:

  • 'metaplay database import-snapshot' imports a database snapshot into an environment.
  • 'metaplay debug database' connects to a database shard interactively.

Examples ​

sh
# Export database from 'nimbly' environment (uses default filename)
metaplay database export-snapshot nimbly
# Export database to a specific file
metaplay database export-snapshot nimbly my_database_snapshot.mdb

Flags ​

  • --force: Proceed with export even if a game server is deployed (DANGEROUS!)

Inherited Flags ​

  • --color <string>: Should the output be colored (yes/no/auto)? [env: METAPLAYCLI_COLOR] (default: auto)
  • --project <string>: Path to the to project directory (where metaplay-project.yaml is located)
  • --skip-version-check: Skip the check for a new CLI version being available
  • --verbose: Enable verbose logging, useful for troubleshooting [env: METAPLAYCLI_VERBOSE]