README
¶
ddlc
ddlc is the DDL contract leaf of the tinywasm SQL ecosystem. It provides the core interfaces and utilities for database schema exporting and topological sorting of foreign keys.
To keep the runtime environment lightweight and free of unnecessary dependencies (especially for WASM compilation), all build-time DDL-generation capabilities and CLI schemas are decoupled from the core runtime (tinywasm/orm) and reside here.
Core Features
ExporterInterface (exporter.go): An interface implemented by dialect-specific SQL adapters (such astinywasm/sqltandtinywasm/postgres) to convert models to their corresponding SQLCREATE TABLEand index definitions in foreign key dependency order.FieldExtStruct (field_ext.go): Holds foreign key database metadata (Ref,RefColumn,OnDelete). By locating it inddlc, dialect compilers and generated models do not need to pull in the heavier runtime ORM module.TopologicalSort(sort.go): Performs Kahn's topological sort (BFS) over models implementing schema extensions (SchemaExt() []FieldExt) to ensure parent tables are created before child tables.
Implementations & Consumers
Implementers of Exporter
tinywasm/sqlt: The SQLite database adapter compiler.tinywasm/postgres: The PostgreSQL database adapter compiler.
Callers of Exporter
tinywasm/ormc: The ORM code generator (viaExportSQL).tinywasm/ormcp: The MCP db tool (viadb_export_schema).
Leaf-Dependency Guarantee
To guarantee portability and allow compilation in frontend or WASM environments, the root package of github.com/tinywasm/ddlc depends only on:
github.com/tinywasm/modelgithub.com/tinywasm/fmt
It does not import tinywasm/orm or any database adapters.
Documentation
¶
Index ¶
Constants ¶
const ( LogOpen = "[..." LogClose = "...]" MsgPrefix = "ddlc handler: " MsgExporting = "Exporting DDL schema..." MsgExportFailed = "Export failed: " MsgExportSuccess = "Export successful. Length: " MsgBytes = " bytes" ErrNotConfigured = "ddlc handler: export function not configured" )
Log message prefix and message constants to avoid repeating string literals.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ExportFunc ¶ added in v0.0.2
ExportFunc produces the DDL SQL for the current project.
type Exporter ¶ added in v0.0.2
Exporter is implemented by SQL adapter compilers (sqlt, postgres). ExportDDL returns CREATE TABLE + index statements for all models, in FK dependency order.
type FieldExt ¶ added in v0.0.2
type FieldExt struct {
model.Field
Ref string // FK: target table name. Empty = no FK.
RefColumn string // FK: target column. Empty = auto-detect PK of Ref table.
OnDelete string // Override ON DELETE action. Empty = CASCADE (default for all FKs).
}
FieldExt extends model.Field with database-specific metadata (foreign keys). Used internally by adapters that support FK constraints.
type Handler ¶ added in v0.0.2
type Handler struct {
// contains filtered or unexported fields
}
Handler implements the TUI HandlerExecution and Loggable interfaces structurally.
func (*Handler) Execute ¶ added in v0.0.2
func (h *Handler) Execute()
Execute triggers the DDL export. Implements devtui.HandlerExecution structurally.
func (*Handler) ExecuteErr ¶ added in v0.0.2
ExecuteErr executes the export and returns the error for test assertion.
func (*Handler) SetExport ¶ added in v0.0.2
func (h *Handler) SetExport(fn ExportFunc)
SetExport injects the DDL export logic.
Source Files