Skip to main content
Version: 0.4 (Latest)

sync

Run a sync configuration created by config create: export the tables, then publish them if the configuration has a publish target. Examples: Examples & Recipes, Resume Failed Exports.

All sync commands also accept the common options.

sync​

Export, then publish.

usage: LakeXpress sync --auth_file AUTH_FILE --lxdb_auth_id ID
--sync_id SYNC_ID [--resume]
[--run_id RUN_ID] [--fastbcp_dir_path PATH]
[common options]
OptionDescription
--sync_id IDRequired. Sync configuration to run (printed by config create, listed by config list)
--resumeResume an incomplete run instead of starting a new one: tables already exported are skipped
--run_id IDRun to resume, with --resume (run IDs are shown in the logs and by status)
--fastbcp_dir_path PATHUse this FastBCP folder instead of the one saved in the configuration

sync[export]​

Export only, without publishing. Useful to publish later with sync[publish].

usage: LakeXpress sync[export] --auth_file AUTH_FILE
--lxdb_auth_id ID --sync_id SYNC_ID
[--fastbcp_dir_path PATH]
[common options]
OptionDescription
--sync_id IDRequired. Sync configuration to export
--fastbcp_dir_path PATHUse this FastBCP folder instead of the one saved in the configuration

In most shells, quote the command name: 'sync[export]'.

sync[publish]​

Publish files already exported by a previous run, without exporting again.

usage: LakeXpress sync[publish] --auth_file AUTH_FILE
--lxdb_auth_id ID --sync_id SYNC_ID
[--run_id RUN_ID] [common options]
OptionDescription
--sync_id IDRequired. Sync configuration to publish
--run_id IDRun whose files to publish (default: the latest completed run)

In most shells, quote the command name: 'sync[publish]'.

Copyright © 2026 Architecture & Performance.