Set up the LakeXpress DB

LakeXpress needs a database of its own, the LakeXpress DB. It stores the sync configurations created by config create, the history and status of every run, and the watermarks of incremental syncs. Every LakeXpress command points to it with --lxdb_auth_id, so it must be set up before the first export.

It is separate from the databases you export from: LakeXpress only writes its own bookkeeping tables there.

Two steps

1. You create the database. On PostgreSQL, SQL Server or MySQL, create an empty database and a user that owns it. SQLite and DuckDB need nothing: the file is created on first use.
2. LakeXpress creates its tables. Run lxdb init once. It creates the tables and checks that the connection works. The first config create or sync also creates them if needed.

Choose a backend

Server database

For production: several users or machines share the same configurations

• PostgreSQLRecommended
• SQL Serverwhen SQL Server is your standard database
• MySQLwhen MySQL is your standard database

Local file

For trying LakeXpress and single-user setups. The configurations and run history live in a file on one machine: syncs run from that machine, one at a time

• SQLite
• DuckDB

Initialize it

After adding the LakeXpress DB entry to your credentials file (see the page of your backend), create the tables:

Windows (PowerShell)

.\LakeXpress.exe lxdb init `
  -a credentials.json `
  --lxdb_auth_id lxdb_postgres

Linux

./LakeXpress lxdb init \
  -a credentials.json \
  --lxdb_auth_id lxdb_postgres

lxdb_postgres is the name of the entry in credentials.json. The command can be run again safely: existing tables and data are kept.

To empty or remove the LakeXpress tables later, see lxdb truncate and lxdb drop in the CLI Reference.