Skip to content
ParticleDB
Release candidateParticleDB 1.1.19-rc.17 is not yet GA or ready for production data.Release status →

Command-line reference

Terminal window
particledb --help
particledb --version
particledb start --help
Command Purpose
start Start the database with a data directory and configuration
init Initialize a data directory
cli Open the SQL client
particles Verify, deploy, inspect and remove function modules in supported distributions
verify Check an offline data directory
bench Run the built-in benchmark tool
version Show build information
repair-resp-wal Offline recovery tool for a specific exported-record repair workflow

Use particledb <command> --help for the installed version’s exact arguments. Offline verification and repair tools must not run against a directory in use by a server.

Terminal window
particledb start --data-dir ./pdb-data --http-addr 127.0.0.1:7173

Configure credentials and TLS for application access. Configuration explains the common settings.

--concurrency-control selects optimistic, strict-optimistic or none. It does not override an explicit transaction’s isolation level. Default: optimistic. --default-isolation sets the session default (default: read-committed). --durability groupsync|sync|none (default: groupsync) controls when a commit is acknowledged, and --kv-durability async|sync (default: async) does the same for KV commands on the Redis-compatible endpoint.

Read concurrency, isolation and durability for the application-facing contract.

Terminal window
particledb particles verify --help
particledb particles deploy --help

Use the module from your first Particle and the loading guide for a complete workflow.

Benchmark commands are for controlled measurements, not production load. Run one at a time and preserve the documented warmups. Benchmark methodology.

Documentation home · Troubleshooting