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

Configure ParticleDB

Terminal window
particledb start --help

Flags vary between distributions. The installed help is the reference for accepted names and values. Avoid copying options from a different release.

The server uses built-in defaults, an optional TOML configuration file, and command-line overrides. Command-line settings override the corresponding file settings.

Terminal window
particledb start --config ./config.toml --data-dir ./pdb-data

An explicitly named configuration file must exist. Keep credentials out of files committed to source control.

Purpose Setting
Persistent records --data-dir
HTTP SQL and health address --http-addr
SQL client address --pg-addr
Redis client address --redis-addr
Initial account --pg-username
Password file --pg-password-file
Authentication --auth-method
TLS --tls-cert, --tls-key
Durability --durability
KV durability (Redis-compatible endpoint) --kv-durability
Concurrency control --concurrency-control
Default session isolation --default-isolation
Server memory --max-server-memory
Query memory --max-statement-memory
Monitoring endpoint --metrics-addr

--concurrency-control (default optimistic), --durability (default groupsync) and --kv-durability (default async) are separate settings; changing one does not change the others.

An explicit transaction defaults to READ COMMITTED unless the session or server default changes. Choosing strict-optimistic does not change that default. Read concurrency, isolation and durability before selecting a mode.

Review the relevant connection, authentication, durability or memory guide. Restart a development instance and verify the result before applying it to production.

Documentation home · Troubleshooting