Sections
Getting started
CLI flags & config
SQL
DDLDMLSELECTFunctions & expressionsTransactions
Clients
HTTP APINative driversPostgreSQL / MySQL wire protocolBinary RPC
Features
RBAC (multi-user)Embeddings (semantic search)File importBackupsDemo showcase mode and .fdb management
Operations
DeploymentArchitectureFileDB on Windows: tray and autostart
Reference
FileDB vs PostgreSQL / MySQL
AI
AI Features: overviewAI Chat and AI AgentSmart Export and AI Import MappingEmbeddings and Hybrid SearchAI setup: providers and presets
Dashboards
Dashboards: overviewDatasets and chartsNo-Code query builderDashboards AI assistantWidgets, grid and filtersPublic links and exportLayout, text cards and KPI comparison

CLI flags & config

Command-line flags

Flag Description Default
-data Directory for .fdb files ./data
-addr HTTP address :8080
-rpc Binary RPC (TCP) address :8081
-no-rpc Disable RPC false
-pg-addr PostgreSQL wire protocol address (e.g. :5432) disabled
-mysql-addr MySQL wire protocol address (e.g. :3306) disabled
-password Admin password (single-password mode) no auth for localhost
-remote Allow non-localhost connections false
-backup-dir Local backup directory <data>/backups
-config Path to a JSON config file
-add-user / -add-user-password / -add-user-role / -add-user-dbs Create/update an RBAC user and exit

Precedence: CLI flag > environment variable > JSON config > default.

Environment variables

FILEDB_DATA, FILEDB_ADDR, FILEDB_PASSWORD, FILEDB_REMOTE=1, FILEDB_PG_ADDR, FILEDB_MYSQL_ADDR, FILEDB_CORS_ORIGIN, FILEDB_TRUSTED_PROXY, FILEDB_AUDIT_LOG.

Files on disk

data/
├── mydb.fdb         ← B-tree, 4 KB pages
├── mydb.fdb.wal     ← Write-ahead log
├── mydb.fdb.embed   ← Embeddings config (api_key, 0600)
├── mydb.fdb.import  ← Saved import profiles
├── users.json       ← RBAC users (if multi-user mode is enabled)
└── backups/
    └── mydb_20260516_120000.fdb.gz

Example

./filedb -data ./databases -addr :8080 -pg-addr :5432 -mysql-addr :3306 -password "$(openssl rand -hex 24)"
Next →
DDL