Reference

Look up syntax, defaults, contracts, support and failure behaviour.

Core

• Configuration
• CLI
• Directives
• Type mapping
• Compatibility
• Known limitations
• Generator API
• Query commands
• Runtime query builder
• Generated Go API
• Output writing API
• Presets
• Errors and observability
• Migration and seed files
• Migration runtime
• Dialect and driver matrix

Dialects

• Dialect reference
• SQLite
• PostgreSQL
• CockroachDB
• TimescaleDB
• MySQL
• MariaDB
• DuckDB
• ClickHouse

Embedding

• Playground and WASM
• Configuration and assembly APIs
• SQL model

Extensions

The Go API is the root package, seagull.sh/seagull, and the sdk kit, with one area per extension point. Each area declares the contracts a program can implement as ports and holds its built-in implementations as provider packages named <area>_<role>_<impl>, such as dialect_engine_postgres or migrate_backend_sqlite. The dialect area has no port: its built-in engines sit behind an opaque handle.

• Dialect API: sdk/dialect
• Emit API: sdk/emit
• Migrate API: sdk/migrate, with the lexical rules a backend splits its files under
• Schema API: sdk/schema
• Observe API: sdk/observe

Orientation

• Glossary

Diagnostics

• Diagnostic codes: generated directly from the engine’s registry.