Set Up Replication
Replications copy Iceberg tables — metadata and data files — from a source catalog to a target catalog.
Create a Replication
- Navigate to Iceberg > Replications
- Click Create New Replication
- Fill in the form:
| Field | Description |
|---|---|
| Name | A descriptive label for this replication |
| Source catalog | The catalog to replicate from |
| Target catalog | The catalog to replicate to (cannot be the same as source) |
| Mode | Continuous or One-time (see below) |
| Copy type | Latest snapshot or All snapshots (see below) |
| Inclusion scopes | One or more scopes selecting which tables to replicate |
| Exclusion scopes | Optional scopes for tables to skip |
- Click Create
Choose a Mode
| Mode | When to use |
|---|---|
| Continuous | Keep the target in sync as changes happen. Requires a Hive source catalog (uses the Metastore event stream). Runs until stopped. |
| One-time | Perform a single sync pass. Works with all catalog types. Use for initial loads, dev snapshots, or ad-hoc copies. |
If the source catalog is not Hive, continuous mode is not available and the mode is automatically set to one-time.
Choose a Copy Strategy
| Copy type | Behaviour |
|---|---|
| Latest snapshot | Copies only the most recent table state. Faster and uses less storage, but the target will not have snapshot history. |
| All snapshots | Copies the complete snapshot history. Preserves time-travel and rollback capabilities on the target. Use for disaster recovery. |
Add Location Mappings
If the source and target catalogs use different storage locations, you must create a location mapping so Ice Flow knows where to write data files.
- Go to the Replications page and click the Location Mappings tab
- Click Create New Location Mapping
- Select the Source warehouse and enter the Source path
- Select the Target warehouse and enter the Target path
- Click Create
The mapping is now available to associate with any replication via the replication's Mappings tab.
See Manage Warehouses for more on warehouse and mapping management.
Start and Stop a Replication
- A newly created replication starts in the Inactive state
- Use the Start action to begin replication
- Use Stop to pause a continuous replication
- One-time replications transition to Complete automatically
Replication States
| State | Meaning |
|---|---|
| Inactive | Created but not yet started |
| Replicating | Actively copying data (continuous mode: watching for changes) |
| Stopped | Manually stopped or paused |
| Complete | One-time replication finished all work |
| Enforced | Paused by license enforcement |
Monitor Replication Progress
Operations Tab
The Operations tab shows table-level sync events. Each row represents one table synchronised during one replication cycle:
| Column | Description |
|---|---|
| Identifier | Unique operation ID |
| Namespace | Namespace containing the table |
| Table | Table name |
| Type | Operation type (COMMIT, CREATE, etc.) |
| Start Time | When the operation started |
| End Time | When the operation completed |
| Data Files | Number of data files committed to the target |
| Total Data | Bytes transferred |
| Duration | Time taken |
Operations are paginated. Use the controls to navigate large result sets.
File Transfers
Click an operation row to reveal the File Transfers panel. This shows each file copied during the operation, with its size and transfer time. A chart visualises file sizes and durations. File transfers are also paginated.
Scopes Tab
Read-only view of the inclusion and exclusion scopes configured for this replication.
Mappings Tab
Shows which location mappings are associated with this replication. Click a mapping to view or edit it.
Settings Tab
Edit the replication name, notes, or delete the replication.
Edit a Replication
- Open the replication from Iceberg > Replications
- Click the Settings tab
- Modify the name or notes
- Click Save
To change scopes, mode, or catalogs, delete the replication and create a new one.
Delete a Replication
- Stop the replication if it is running
- Open the Settings tab
- Click Delete Replication