Configuration Management

Commands use Linux syntax. See Examples & Recipes for the Windows equivalents and the arguments every sync needs.

# Create a sync configuration (the other recipes show all the options)
./LakeXpress config create -a credentials.json --lxdb_auth_id lxdb_mssql --source_db_auth_id source_postgres --source_schema_name public --output_dir ./exports

# List the sync configurations
./LakeXpress config list -a credentials.json --lxdb_auth_id lxdb_mssql

# Show the runs of a sync configuration and their status
./LakeXpress status -a credentials.json --lxdb_auth_id lxdb_mssql --sync_id <SYNC_ID>

Delete a Sync Configuration

Without --confirm, config delete only shows what would be deleted: the configuration, its runs, table metadata and watermarks. Exported files and published tables are kept.

# Preview
./LakeXpress config delete -a credentials.json --lxdb_auth_id lxdb_mssql --sync_id <SYNC_ID>

# Delete
./LakeXpress config delete -a credentials.json --lxdb_auth_id lxdb_mssql --sync_id <SYNC_ID> --confirm

Export Now, Publish Later

sync exports and then publishes. The two steps can also be run separately, for example to publish outside business hours:

# Export only
./LakeXpress 'sync[export]' -a credentials.json --lxdb_auth_id lxdb_mssql --sync_id <SYNC_ID>

# Publish the files of the latest completed run
./LakeXpress 'sync[publish]' -a credentials.json --lxdb_auth_id lxdb_mssql --sync_id <SYNC_ID>

Clean Up Stale Runs

Remove runs stuck in running after a crash, or failed runs, older than 7 days. Completed runs and exported files are kept:

# Preview
./LakeXpress cleanup -a credentials.json --lxdb_auth_id lxdb_mssql --sync_id <SYNC_ID> --older-than 7d --dry-run

# Remove
./LakeXpress cleanup -a credentials.json --lxdb_auth_id lxdb_mssql --sync_id <SYNC_ID> --older-than 7d

Legacy YAML Configuration

Each sync run writes a copy of its configuration next to its log file. It can be run again with run:

./LakeXpress run -c lx_20251222_101500_<RUN_ID>.yml