Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

grizzle

package module

Go to main page

Versions in this module

v0

v0.2.0

Oct 14, 2026

Changes in this version

+ var ErrLockContention = plan.ErrLockContention

+ var ErrNoMatchingSchemas = plan.ErrNoMatchingSchemas

+ func IsReady(ctx context.Context, db *sql.DB, opts ...Option) (bool, error)

type ApplyOpts

+ DevDatabaseURL string

+ FailOnContention bool

+ Metrics Metrics

type BaselineOptions

+ DevDatabaseURL string

type LintRule

+ func FilterLintRules(rules []LintRule, disabledIDs []string) []LintRule

+ func LintRulesForProfile(profile string) ([]LintRule, error)

+ type LockConflict = plan.LockConflict

+ type LockContentionError = plan.LockContentionError

+ type Metrics = exec.Metrics

type Option

+ func WithDevDatabaseURL(url string) Option

+ func WithFailOnContention(fail bool) Option

+ func WithMetrics(m Metrics) Option

+ func WithTargetSchemaPattern(pattern string) Option

type Options

+ DevDatabaseURL string

+ FailOnContention bool

+ Metrics Metrics

+ TargetSchemaPattern string

v0.1.0

Oct 13, 2026

Changes in this version

+ const ChangeAddCheck

+ const ChangeAddColumn

+ const ChangeAddFK

+ const ChangeAlterColumn

+ const ChangeAlterCompositeType

+ const ChangeAlterEnum

+ const ChangeAlterPolicy

+ const ChangeAlterSequence

+ const ChangeAttachPartition

+ const ChangeCreateCompositeType

+ const ChangeCreateEnum

+ const ChangeCreateExtension

+ const ChangeCreateFunction

+ const ChangeCreateIndex

+ const ChangeCreatePolicy

+ const ChangeCreateRangeType

+ const ChangeCreateSequence

+ const ChangeCreateTable

+ const ChangeCreateTrigger

+ const ChangeCreateView

+ const ChangeDetachPartition

+ const ChangeDisableRLS

+ const ChangeDropCheck

+ const ChangeDropColumn

+ const ChangeDropCompositeRetype

+ const ChangeDropCompositeType

+ const ChangeDropEnumValue

+ const ChangeDropExtension

+ const ChangeDropFK

+ const ChangeDropFunction

+ const ChangeDropIndex

+ const ChangeDropPolicy

+ const ChangeDropRangeRetype

+ const ChangeDropRangeType

+ const ChangeDropSequence

+ const ChangeDropTable

+ const ChangeDropTrigger

+ const ChangeDropView

+ const ChangeEnableRLS

+ const ChangeForceRLS

+ const ChangeNoForceRLS

+ const ChangeRefreshMatView

+ const ChangeRenameColumn

+ const ChangeRenameEnumValue

+ const ChangeValidateConstraint

+ const ExportFormatAtlas

+ const ExportFormatGolangMigrate

+ const ExportFormatGoose

+ const ExportFormatMigrate

+ const ExportFormatSQL

+ const HazardCheckValidateScan

+ const HazardDropCheck

+ const HazardDropColumn

+ const HazardDropCompositeType

+ const HazardDropDomain

+ const HazardDropEnumValue

+ const HazardDropExtension

+ const HazardDropFK

+ const HazardDropFunction

+ const HazardDropIndex

+ const HazardDropPolicy

+ const HazardDropRangeType

+ const HazardDropSequence

+ const HazardDropTable

+ const HazardDropTrigger

+ const HazardDropView

+ const HazardExtensionPrivilege

+ const HazardGeneratedRewrite

+ const HazardIndexBuild

+ const HazardLevelCritical

+ const HazardLevelNotice

+ const HazardLevelWarning

+ const HazardNotNullNoDefault

+ const HazardPartitionAttachScan

+ const HazardPartitionPendingDetach

+ const HazardRLSEnable

+ const HazardRenameAmbiguous

+ const HazardSecurityDefiner

+ const HazardTypeNarrow

+ const HazardUnmanagedDependency

+ const LintSeverityError

+ const LintSeverityInfo

+ const LintSeverityWarning

+ const PartitionStrategyHash

+ const PartitionStrategyList

+ const PartitionStrategyRange

+ const UnmanagedDomain

+ const UnmanagedEnum

+ const UnmanagedFunction

+ const UnmanagedMaterialized

+ const UnmanagedSequence

+ const UnmanagedTrigger

+ const UnmanagedView

+ var ErrAfterSyncFailed = plan.ErrAfterSyncFailed

+ var ErrBaselineDrift = plan.ErrBaselineDrift

+ var ErrCompilationFailed = plan.ErrCompilationFailed

+ var ErrDestructiveBlocked = plan.ErrDestructiveBlocked

+ var ErrDrift = plan.ErrDrift

+ var ErrEmptySchema = plan.ErrEmptySchema

+ var ErrExecutionFailed = plan.ErrExecutionFailed

+ var ErrHazardBlocked = plan.ErrHazardBlocked

+ var ErrHistoryRecord = plan.ErrHistoryRecord

+ var ErrInspectionFailed = plan.ErrInspectionFailed

+ var ErrInvalidOptions = plan.ErrInvalidOptions

+ var ErrLockAcquisition = plan.ErrLockAcquisition

+ var ErrLockTimeout = plan.ErrLockTimeout

+ var ErrNoFailedMigration = plan.ErrNoFailedMigration

+ var ErrPartitionConversion = plan.ErrPartitionConversion

+ var ErrPartitionKeyNotInUnique = plan.ErrPartitionKeyNotInUnique

+ var ErrPlanDrift = plan.ErrPlanDrift

+ var ErrPriorFailureBlocked = plan.ErrPriorFailureBlocked

+ var ErrSeedFailed = plan.ErrSeedFailed

+ var ErrStrictScope = plan.ErrStrictScope

+ var ErrTransactionPooling = plan.ErrTransactionPooling

+ var ErrUnsupportedDialect = plan.ErrUnsupportedDialect

+ var ErrUnsupportedMultiSchema = plan.ErrUnsupportedMultiSchema

+ func Apply(ctx context.Context, db *sql.DB, p *Plan, opts ApplyOpts) error

+ func BuildIdempotentInsert(table string, columns []string, conflictTarget string, updateColumns ...string) string

+ func Check(ctx context.Context, db *sql.DB, opts Options) error

+ func Dump(ctx context.Context, db *sql.DB, opts DumpOptions) (string, error)

+ func GenerateLockID(dbName, schemaName string) int64

+ func LintFormatGitHub(w io.Writer, diags []LintDiagnostic) error

+ func LintFormatJSON(w io.Writer, diags []LintDiagnostic) error

+ func LintFormatText(w io.Writer, diags []LintDiagnostic) error

+ func LintHasErrors(diags []LintDiagnostic) bool

+ func Seed(ctx context.Context, db *sql.DB, seedSQL string, opts ...Option) error

+ func SeedHash(seedSQL string) string

+ func Sync(ctx context.Context, db *sql.DB, opts Options) error

+ type ApplyOpts struct

+ AcceptHazards []HazardCode

+ AfterStep StepHook

+ AfterSync SyncHook

+ Backfill BackfillFunc

+ BeforeStep StepHook

+ BeforeSync SyncHook

+ ExpectedHash string

+ LockNamespace string

+ Logger *slog.Logger

+ SQLiteAttach map[string]string

+ SQLiteRebuildBatchSize int

+ SQLiteRebuildThreshold int

+ Tracer Tracer

+ type BackfillFunc func(ctx context.Context, tx *sql.Tx, table, oldCol, newCol string) error

+ type BaselineOptions struct

+ Force bool

+ Note string

+ TargetSchema string

+ type ChangeType = plan.ChangeType

+ type CheckConstraintIR = schema.CheckConstraint

+ type ColumnIR = schema.Column

+ type CompositeAttributeIR = schema.CompositeAttribute

+ type CompositeTypeIR = schema.CompositeType

+ type DependencyRef = schema.DependencyRef

+ type DestructiveViolationError = plan.DestructiveViolationError

+ type Dialect string

+ const DialectAuto

+ const DialectPostgres

+ const DialectSQLite

+ type DriftError = plan.DriftError

+ type DropPolicy = plan.DropPolicy

+ type DryRunResult = exec.DryRunResult

+ func DryRunVerify(ctx context.Context, db *sql.DB, opts Options) (*DryRunResult, error)

+ func DryRunVerifyPlan(ctx context.Context, db *sql.DB, p *Plan, opts ApplyOpts) (*DryRunResult, error)

+ type DumpOptions struct

+ TargetSchema string

+ type EnumIR = schema.Enum

+ type ExportArtifact = export.Artifact

+ func Export(p *Plan, format ExportFormat, version string, timestamp ...time.Time) ([]ExportArtifact, error)

+ type ExportFormat = export.Format

+ type ExtensionIR = schema.Extension

+ type ForeignKeyIR = schema.ForeignKey

+ type GeneratedColumn = schema.GeneratedColumn

+ type Hazard = plan.Hazard

+ type HazardCode = plan.HazardCode

+ type HazardError = plan.HazardError

+ type HazardLevel = plan.HazardLevel

+ type HistoryEntry struct

+ AppliedAt time.Time

+ AppliedBy string

+ DurationMs int64

+ Error string

+ FailedStep int

+ ID int64

+ PlanHash string

+ SeedHash string

+ Status string

+ StepsJSON string

+ func Baseline(ctx context.Context, db *sql.DB, schemaSQL string, opts BaselineOptions) (*HistoryEntry, error)

+ func ListHistory(ctx context.Context, db *sql.DB, opts HistoryOptions) ([]HistoryEntry, error)

+ func Repair(ctx context.Context, db *sql.DB, opts RepairOptions) (*HistoryEntry, error)

+ type HistoryOptions struct

+ Descending bool

+ Limit int

+ TargetSchema string

+ type HookContext = exec.HookContext

+ type IndexIR = schema.Index

+ type LintDiagnostic = lint.Diagnostic

+ func LintSchema(s *SchemaIR, rules ...LintRule) []LintDiagnostic

+ func LintSeed(seedSQL string) []LintDiagnostic

+ type LintRule = lint.Rule

+ func DefaultLintRules() []LintRule

+ type LintSeverity = lint.Severity

+ type Option func(*Options)

+ func WithAcceptHazards(hazards ...plan.HazardCode) Option

+ func WithAfterStep(fn StepHook) Option

+ func WithAfterSync(fn SyncHook) Option

+ func WithAllowDrop(allow bool) Option

+ func WithAllowResumePartial(allow bool) Option

+ func WithBackfill(fn BackfillFunc) Option

+ func WithBeforeStep(fn StepHook) Option

+ func WithBeforeSync(fn SyncHook) Option

+ func WithDialect(d Dialect) Option

+ func WithDryRun() Option

+ func WithDryRunLockTimeout(d time.Duration) Option

+ func WithExcludeTables(tables ...string) Option

+ func WithExecuteHooksInDryRun() Option

+ func WithExpandContract(expand bool) Option

+ func WithExpectedHash(hash string) Option

+ func WithIncludeTables(tables ...string) Option

+ func WithLockNamespace(ns string) Option

+ func WithLockTimeout(d time.Duration) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithMaxRetries(n int) Option

+ func WithNonConcurrentIndexes(disabled bool) Option

+ func WithRandFloat(fn func() float64) Option

+ func WithRenames(renames map[string]string) Option

+ func WithSQLiteAttach(attach map[string]string) Option

+ func WithSQLiteRebuildBatching(threshold, batchSize int) Option

+ func WithSeedForce(force bool) Option

+ func WithSeedSQL(seedSQL string) Option

+ func WithStatementTimeout(d time.Duration) Option

+ func WithStrictScope(strict bool) Option

+ func WithTargetSchema(schema string) Option

+ func WithTargetSchemas(schemas ...string) Option

+ func WithTracer(t Tracer) Option

+ type Options struct

+ AcceptHazards []plan.HazardCode

+ AfterStep StepHook

+ AfterSync SyncHook

+ AllowDrop bool

+ AllowDropCheck *bool

+ AllowDropColumn *bool

+ AllowDropCompositeType *bool

+ AllowDropDomain *bool

+ AllowDropEventTrigger bool

+ AllowDropExtension *bool

+ AllowDropFK *bool

+ AllowDropFunction *bool

+ AllowDropIndex *bool

+ AllowDropPolicy *bool

+ AllowDropPublication bool

+ AllowDropRangeType *bool

+ AllowDropReplicationSlot bool

+ AllowDropRole bool

+ AllowDropSequence *bool

+ AllowDropSubscription bool

+ AllowDropTable *bool

+ AllowDropTrigger *bool

+ AllowDropType *bool

+ AllowDropView *bool

+ AllowResumePartial bool

+ AllowRevoke bool

+ Backfill BackfillFunc

+ BeforeStep StepHook

+ BeforeSync SyncHook

+ CatalogSQL string

+ Dialect Dialect

+ DryRun bool

+ DryRunLockTimeout time.Duration

+ ExcludeTables []string

+ ExecuteHooksInDryRun bool

+ ExpandContract bool

+ ExpectedHash string

+ IncludeTables []string

+ LockID int64

+ LockNamespace string

+ LockTimeout time.Duration

+ Logger *slog.Logger

+ MaxRetries int

+ NonConcurrentIndexes bool

+ RandFloat func() float64

+ Renames map[string]string

+ RolesSQL string

+ SQLiteAttach map[string]string

+ SQLiteRebuildBatchSize int

+ SQLiteRebuildThreshold int

+ SchemaSQL string

+ SeedForce bool

+ SeedSQL string

+ ShadowSchema string

+ StatementTimeout time.Duration

+ StrictScope bool

+ TargetSchema string

+ TargetSchemas []string

+ Tracer Tracer

+ func Development(schemaSQL string, opts ...Option) Options

+ func Production(schemaSQL string, opts ...Option) Options

+ func (o *Options) Validate() error

+ type PartitionKey = schema.PartitionKey

+ type PartitionOf = schema.PartitionOf

+ type PartitionStrategy = schema.PartitionStrategy

+ type Plan = plan.Plan

+ func ParsePlanJSON(data []byte) (*Plan, string, error)

+ func PlanDiff(ctx context.Context, db *sql.DB, opts Options) (*Plan, error)

+ type PlanDocument = plan.Document

+ type PolicyIR = schema.Policy

+ type PrimaryKeyIR = schema.PrimaryKey

+ type RangeTypeIR = schema.RangeType

+ type RepairOptions struct

+ Note string

+ TargetSchema string

+ type RoutineIR = schema.Routine

+ type SchemaIR = schema.Schema

+ func CompileSchema(ctx context.Context, db *sql.DB, opts Options) (*SchemaIR, error)

+ type ScopeDocument = plan.ScopeDocument

+ type SequenceIR = schema.Sequence

+ type Span = exec.Span

+ type StatusReport struct

+ AppliedCount int

+ Dialect string

+ FailedCount int

+ InSync bool

+ Latest *HistoryEntry

+ PartialCount int

+ PendingSteps int

+ TargetSchema string

+ func Status(ctx context.Context, db *sql.DB, opts Options) (*StatusReport, error)

+ type Step = plan.Step

+ type StepHook = exec.StepHook

+ type SyncHook = exec.SyncHook

+ type TableIR = schema.Table

+ type Tracer = exec.Tracer

+ type TriggerIR = schema.Trigger

+ type UnmanagedKind = schema.UnmanagedKind

+ type UnmanagedObject = schema.UnmanagedObject

+ type ViewIR = schema.View

v0.1.0-rc5

Oct 13, 2026

v0.1.0-rc4

Oct 13, 2026

v0.1.0-rc3

Oct 12, 2026

v0.1.0-rc2

Oct 7, 2026

v0.1.0-rc.1

Oct 7, 2026