Documentation
¶
Overview ¶
Package migrate provides internal utilities for database schema migrations.
Index ¶
- func IsBoolColumn(t reflect.Type) bool
- func NormalizeBoolDefault(dialectName, def string) string
- func RegisterTypeMapper(t reflect.Type, m TypeMapper)
- func SQLType(dialectName string, t reflect.Type, isPK bool) string
- func SQLTypeWithOpts(dialectName string, t reflect.Type, opts TypeOptions) string
- type TypeMapper
- type TypeOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsBoolColumn ¶ added in v1.1.1
IsBoolColumn reports whether t maps to a boolean column. It unwraps a pointer (*bool) and the sql.Null[bool] / quark.Nullable[bool] wrapper the same way SQLTypeWithOpts resolves the column's SQL type, so the default-normalization decision stays consistent with the emitted column type. Callers use it to gate NormalizeBoolDefault.
func NormalizeBoolDefault ¶ added in v1.1.1
NormalizeBoolDefault rewrites a boolean column's `default:"..."` literal to the form the target dialect accepts in a DDL DEFAULT clause.
Quark passes a column default through to DDL verbatim, but a boolean default has NO single literal portable across the six engines: PostgreSQL's BOOLEAN requires TRUE/FALSE and rejects 1/0 (SQLSTATE 42804), while MSSQL's BIT and Oracle's NUMBER(1) require 1/0 and reject TRUE/FALSE. This recognizes the documented bool literals 1/0/true/false (case-insensitive) and emits the dialect-appropriate one (TRUE/FALSE for PostgreSQL, 1/0 for the rest).
Input must be one of 1/0/true/false (case-insensitive); any other string — a function call, a quoted literal, a non-bool value — is returned UNCHANGED, so non-boolean columns and custom expressions are unaffected. Callers gate this on IsBoolColumn; validating the default tag itself is the caller's job.
func RegisterTypeMapper ¶ added in v0.3.0
func RegisterTypeMapper(t reflect.Type, m TypeMapper)
RegisterTypeMapper registers a custom Go-type → SQL-type mapping. The public API in package quark forwards to this; the registry lives here because internal/migrate.SQLType is the only consumer and we want the lookup to stay close to the lookup site.
Pointer types are stripped before registration: registering for time.Duration also covers *time.Duration. Re-registering the same type overwrites the previous mapper.
func SQLType ¶
SQLType maps Go types to SQL types for the given dialect name.
When isPK is true the column DDL includes the PRIMARY KEY constraint. The exact type depends on the Go field kind:
- int / int64 → dialect-native auto-increment (SERIAL, AUTO_INCREMENT, IDENTITY…)
- string → VARCHAR(36) PRIMARY KEY — UUID-friendly; no auto-increment
- anything else → its natural SQL type + PRIMARY KEY (no auto-increment)
func SQLTypeWithOpts ¶ added in v0.3.0
func SQLTypeWithOpts(dialectName string, t reflect.Type, opts TypeOptions) string
SQLTypeWithOpts is the extended form of SQLType that propagates the field's sizing hints to the type mapper. It is the preferred entry point for the migrate / sync layers; SQLType remains as a convenience wrapper for callers that don't (yet) have TypeOptions.
Types ¶
type TypeMapper ¶ added in v0.3.0
type TypeMapper func(dialect string, opts TypeOptions) string
TypeMapper produces a dialect-specific SQL type for a Go type. The caller supplies the dialect name (lower-case: "postgres", "mysql", ...) and the sizing hints from the field's tag. Implementations should fall back to sensible defaults if Size/Precision/Scale are zero.
func LookupTypeMapper ¶ added in v0.3.0
func LookupTypeMapper(t reflect.Type) TypeMapper
LookupTypeMapper returns the registered mapper for t (pointer stripped). Returns nil if no mapping is registered.
Source Files