Examples & Recipes
Tested commands for common LakeXpress scenarios, grouped by task.
Commands use Linux syntax. On Windows PowerShell, replace \ with ` at the end of lines, and ./LakeXpress with .\LakeXpress.exe.
The commands leave out --fastbcp_dir_path: LakeXpress finds its bundled FastBCP engine automatically. To use another FastBCP installation, add --fastbcp_dir_path <folder containing FastBCP> to config create.
The credentials entry names (lxdb_postgres, source_postgres, s3_01, snowflake_prod...) are examples: use the names from your own credentials.json.
The examples assume the license file is saved in a default location (~/.lakexpress/license.lic, %APPDATA%\LakeXpress\license.lic or ./license.lic). Otherwise add --license_file <path> to every command, after the command name:
./LakeXpress sync \
-a credentials.json \
--lxdb_auth_id lxdb_postgres \
--sync_id <SYNC_ID> \
--license_file ~/licenses/LakeXpress.lic
For scheduled jobs, CI and containers, see License Resolution.
The sync, sync[export], and sync[publish] commands require -a, --lxdb_auth_id, and --sync_id. The <SYNC_ID> in the examples refers to the sync ID printed by config create.
Manage LakeXpress
- LakeXpress DBinitialize, empty, drop and unlock the LakeXpress DB, for each supported backend
- Configuration Managementcreate, list and delete sync configurations, check their status
Export
Local ExportsPostgreSQL, SQL Server, MySQL, MariaDB and Teradata to local disk
AWS S3Parquet files on S3 and S3-compatible storage
Azure StorageParquet files on Azure Blob Storage and ADLS Gen2
Google Cloud StorageParquet files on GCS
OneLakeParquet files on Microsoft OneLake
Publish
Snowflakeexternal and internal tables
Databrickstables in Unity Catalog
AWS Gluetables in the Glue Data Catalog, from S3
Microsoft Fabrictables in Fabric, from OneLake
BigQueryexternal and internal tables- Amazon Redshiftexternal and internal tables
MotherDuckexternal and internal tables
DuckLakeexternal tables
Refine and operate
- Table Filteringinclude and exclude table patterns
- Incremental Syncexport only new or changed rows
- Resume Failed Exportsretry only the tables that failed