Documentation

Everything you need to build with SOFI.

Step-by-step guides, concepts, working examples, and complete API reference. For first-timers and seasoned veterans.

Getting started

Create your account, configure your first data source, and provision your first VDB.

Data sources

Register PostgreSQL, MySQL, Oracle, and 35+ databases. Configure connections and pools.

Virtual Databases

Provision, manage, and expire VDBs. Snapshots, virtual clones, and TTL.

Masking

Compliance rules, PII detector, referential consistency, hyperscale.

CDC

Change Data Capture via WAL, binlog, and LogMiner. Sub-second latency.

Auth & RBAC

JWT, roles, granular permissions, SSO via OIDC/SAML.

REST API

Bearer JWT auth. Easy CI/CD integration.

Integrations

GitHub Actions, webhooks, Slack notifications, and an MCP server.

Administration

Multi-tenancy, audit logs, billing, and advanced configuration.

Quickstart

From zero to first VDB in 5 minutes.

Install the CLI, authenticate, register a data source, and provision a masked VDB. The full guide walks each step with real examples.

Read full quickstart
# 1. Install
$ npm install -g @sofi/cli

# 2. Authenticate
$ sofi auth login

# 3. Register a source
$ sofi datasource add prod-db \
    --type postgresql \
    --host db.company.com

# 4. Create a masked VDB
$ sofi vdb create --from prod-db \
                  --rules pii-strict.yml

✓ VDB ready in 47s