dbx

DBX Database Code Generator

DBX generates database schemas and Go code for interacting with databases. It supports Postgres (pgx), CockroachDB (pgxcockroach), Spanner, and SQLite3 dialects.

Installation

go install storj.io/dbx@latest

CLI Commands

# Generate Go code
dbx golang [-p package] [-d dialect] [-t templates] [--userdata] [-i include.dbx] schema.dbx outdir

# Generate SQL schema
dbx schema [-d dialect] [-i include.dbx] schema.dbx outdir

# Format dbx file (reads stdin, writes stdout)
dbx format < input.dbx > output.dbx

Dialect Options

• pgx (default) - PostgreSQL via pgx driver
• pgxcockroach - CockroachDB via pgx driver
• spanner - Google Cloud Spanner via go-sql-spanner
• sqlite3 - SQLite3

Go Generate Directive

//go:generate dbx golang -d pgx -d pgxcockroach -d spanner schema.dbx .
//go:generate dbx schema -d pgx -d pgxcockroach -d spanner schema.dbx .

DBX File Syntax

DBX uses a tuple/list grammar. Lists are parentheses-enclosed comma-separated tuples. Newlines auto-insert commas.

Model Definition

model <name> (
    // Optional: custom table name
    table <table_name>

    // Required: primary key (single or composite)
    key <field_names>

    // Optional: unique constraints
    unique <field_names>

    // Optional: indexes
    index (
        name <index_name>
        fields <field_names>
        unique              // optional
        storing <fields>    // optional: include columns (covering index)
        where <condition>   // optional: partial index
    )

    // Fields
    field <name> <type> ( attributes )

    // Foreign key relations
    field <name> <model>.<field> <relation> ( attributes )
)

Field Types

Type	Go Type	Description
serial	int	Auto-incrementing integer
serial64	int64	Auto-incrementing 64-bit integer
int	int	32-bit integer
int64	int64	64-bit integer
uint	uint	Unsigned 32-bit integer
uint64	uint64	Unsigned 64-bit integer
bool	bool	Boolean
text	string	Text/varchar
timestamp	time.Time	Timestamp with timezone
utimestamp	time.Time	Timestamp without timezone (UTC)
float	float32	32-bit float
float64	float64	64-bit float
blob	[]byte	Binary data
json	[]byte	JSON data (uses JSON/JSONB SQL type)
date	time.Time	Date only