Export your Nakama database

Heroic Cloud gives you full access to your data at all times. Use Data Export to download a complete PostgreSQL snapshot of your deployment’s database for backup, analysis, migration, or any other reason.

Prerequisites #

  • Access to the Nakama deployment’s Data Export tab (requires Export permission).
  • The pg_restore tool installed locally (if importing the export).

Steps #

  1. Navigate to your Nakama deployment and select the Data Export tab.
  2. Select Start new data export. Only one export can run at a time.
  3. Wait for the export to complete. The table shows who triggered it, status, start time, and end time.
  4. Select the download link to retrieve the export file. Links expire after a limited time. Start a new export if the link has expired.

Verify #

Confirm the downloaded file exists and isn’t empty. If importing, run:

1

pg_restore --host=<target-host> --port=5432 --username=<user> --dbname=<database> --no-owner --no-acl <export-file>

Use cases #

  • Backups as periodic manual backups in addition to the automatic daily backups (stored for a 7-day rolling window).
  • Local development by importing production data into a local Nakama instance for debugging.
  • Migration to move data between deployments or to a self-hosted environment. If you ever leave Heroic Cloud, your data comes with you.
  • Analytics by running queries against a copy of your data without impacting production performance.
  • Compliance to satisfy data portability requirements under GDPR or other regulations.

Troubleshooting #

  • Export stuck in progress: Only one export can run at a time. Wait for the current export to complete or contact Heroic Labs (support@heroiclabs.com).
  • Download link expired: Start a new export. Links expire after a limited period.

See also #