Skip to main content
PARIXDocs
Getting started

Import a database

Import an existing TigerBeetle cluster into Parix from .tigerbeetle replica files.

The import flow lives in the same /new page as database creation. Select Import Database to stage existing TigerBeetle files and provision a hosted Parix database from them.

Use this guide when the source of truth already exists as TigerBeetle replica files. Use Create a database when you want an empty database.

Import steps

  1. Open /new?mode=import.
  2. Choose the target organization, provider, region, topology, storage, and cluster size.
  3. Add one .tigerbeetle file for each replica index in the selected topology.
  4. Confirm the detected cluster ID and replica set.
  5. Submit the import and wait for the database profile to become ready.

File requirements

The importer expects exactly one .tigerbeetle file for each replica index in the selected topology. The UI recommends this naming pattern:

${CLUSTER_ID}_${REPLICA_INDEX}.tigerbeetle

Replica indexes are zero-based. The file name helps operators keep files organized, but Parix validates the embedded TigerBeetle metadata rather than trusting only the name.

Validation

Before the import workflow is queued, Parix validates:

  • file extension
  • embedded superblock metadata
  • cluster ID consistency across files
  • replica count and replica indexes
  • duplicate or missing replica indexes
  • TigerBeetle version compatibility
  • selected topology versus detected replica set

Imported TigerBeetle files with a version newer than the supported target version are rejected.

Upload and workflow behavior

Validated files are staged in object storage under an import-specific key. Parix then:

  • creates the database and profile records
  • records import artifacts
  • creates an import job
  • starts the import database workflow
  • marks the profile as provisioning until the workflow completes

Import is blocked when another decommission, import, provision, backup, or restore workflow is already active for the same database.

Provider support

The current import helper supports provider-backed deployments on GCP and AWS. The target shape must match the selected catalog choices and the replica files being imported.