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
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

dbcontract

package

Go to main page

Versions in this module

v0

v0.2.4

May 24, 2026

v0.2.3

May 24, 2026

v0.2.2

May 23, 2026

v0.2.1

May 14, 2026

v0.2.0

May 12, 2026

Changes in this version

+ const ContractArtifactKind

+ const ContractSchemaVersion

+ const DefaultContractOutputPath

+ const DefaultImpactOutputPath

+ const DefaultValidationOutputPath

+ const ImpactArtifactKind

+ const ImpactSchemaVersion

+ const ValidationArtifactKind

+ const ValidationSchemaVersion

+ func ClassifySQL(sql string) (classification string, destructive []SQLClassification, ...)

+ func MarshalContractDeterministic(c *Contract) ([]byte, error)

+ func MarshalImpactDeterministic(i *Impact) ([]byte, error)

+ func MarshalValidationDeterministic(v *Validation) ([]byte, error)

+ func WriteContract(path string, c *Contract) error

+ func WriteImpact(path string, i *Impact) error

+ func WriteValidation(path string, v *Validation) error

+ type Binding struct

+ Bootstrap Bootstrap

+ Checks Checks

+ Credentials Credentials

+ Engine Engine

+ ID string

+ MigrationPolicy MigrationPolicy

+ Migrations Migrations

+ Name string

+ Origin artifact.Origin

+ ProofLevel artifact.ProofLevel

+ ProviderExpectations ProviderExpectations

+ Purpose string

+ RegionEnablement RegionEnablement

+ Required bool

+ SchemaSnapshot SchemaSnapshot

+ SourceRef artifact.SourceRef

+ Topology Topology

+ type BindingImpact struct

+ AddedMigrations []string

+ BindingID string

+ CandidateDigest string

+ Classification string

+ DataMigrationStatements []ClassifiedStatement

+ DestructiveStatements []ClassifiedStatement

+ ManualReasons []string

+ ModifiedExistingMigrations []string

+ PreviousDigest string

+ RemovedMigrations []string

+ type BindingValidation struct

+ BindingID string

+ Diagnostics []artifact.Diagnostic

+ DriftValidation UnsupportedValidationPhase

+ FreshValidation UnsupportedValidationPhase

+ SourceValidation SourceValidationResult

+ Status string

+ TopologyValidation UnsupportedValidationPhase

+ type Bootstrap struct

+ CombinedDigest string

+ ContainsCustomerData bool

+ Paths []FileRef

+ type BuildOptions struct

+ AppVersion string

+ Commit string

+ Database config.DatabaseConfig

+ ImpactOutputPath string

+ Module string

+ Name string

+ NeonEnabled bool

+ OutputPath string

+ ProjectRoot string

+ ToolVersion string

+ ValidationOutputPath string

+ type Capabilities struct

+ DeclarationValidation string

+ DriftValidation string

+ FreshDatabaseValidation string

+ MigrationInputValidation string

+ ProductionMigrationExecution string

+ ProviderDiff string

+ StaticSQLClassification string

+ TopologyValidation string

+ type Checks struct

+ PostFreshSQL []string

+ type ClassifiedStatement struct

+ MigrationID string

+ Path string

+ Reason string

+ Statement string

+ type Contract struct

+ Analysis artifact.Analysis

+ App artifact.App

+ ArtifactID string

+ ArtifactKind string

+ Bindings []Binding

+ Capabilities Capabilities

+ DatabaseMode DatabaseMode

+ Diagnostics []artifact.Diagnostic

+ DiscoveredSignals []DiscoveredSignal

+ Inputs []artifact.ArtifactRef

+ OperationReadiness []artifact.OperationReadiness

+ Outputs []artifact.ArtifactRef

+ Producer artifact.Producer

+ ProviderProfiles []artifact.ProfileFact

+ References map[string]artifact.ArtifactRef

+ SchemaVersion string

+ func BuildContract(opts BuildOptions) (*Contract, error)

+ func LoadContract(path string) (*Contract, error)

+ type Credentials struct

+ AdminEnv string

+ MigrationEnv string

+ MigrationRequiresDirect bool

+ ReadOnlyEnv string

+ RuntimeEnv string

+ SecretValuesInContract bool

+ ValidationEnv string

+ type DatabaseMode struct

+ Explicit bool

+ Mode string

+ Origin artifact.Origin

+ ProofLevel artifact.ProofLevel

+ SourceRef artifact.SourceRef

+ type DiscoveredSignal struct

+ ID string

+ Kind string

+ Origin artifact.Origin

+ Path string

+ ProofLevel artifact.ProofLevel

+ Reason string

+ SourceRef artifact.SourceRef

+ type Engine struct

+ Extensions []string

+ Family string

+ Features []string

+ MinimumVersion string

+ type FileRef struct

+ Digest string

+ Path string

+ type Impact struct

+ Analysis artifact.Analysis

+ App artifact.App

+ ArtifactID string

+ ArtifactKind string

+ Bindings []BindingImpact

+ Classification string

+ Diagnostics []artifact.Diagnostic

+ Inputs []artifact.ArtifactRef

+ OperationReadiness []artifact.OperationReadiness

+ Outputs []artifact.ArtifactRef

+ Producer artifact.Producer

+ References map[string]artifact.ArtifactRef

+ RequiresDBReview bool

+ ReviewClass string

+ Rollback RollbackPosture

+ SchemaVersion string

+ func BuildImpact(opts ImpactOptions) (*Impact, error)

+ type ImpactOptions struct

+ AppVersion string

+ Candidate *Contract

+ Commit string

+ Module string

+ Name string

+ OutputPath string

+ Previous *Contract

+ ProjectRoot string

+ ToolVersion string

+ type MigrationFile struct

+ ClassificationHint string

+ Digest string

+ HasDown bool

+ HasUp bool

+ ID string

+ Kind string

+ Name string

+ Path string

+ ProofLevel artifact.ProofLevel

+ SourceRef artifact.SourceRef

+ Version string

+ type MigrationPolicy struct

+ DataMigrationRequiresReview bool

+ DestructiveRequiresReview bool

+ ProductionApply string

+ StartupApplyAllowed string

+ type Migrations struct

+ AllowOutOfOrder bool

+ CombinedDigest string

+ Dialect string

+ Directories []string

+ EmbedPattern string

+ Files []MigrationFile

+ Ordering string

+ Table string

+ Tool string

+ type Partitioning struct

+ DeclaredBy string

+ RequestRoutingKey string

+ Strategy string

+ type ProviderExpectations struct

+ ChannelBindingRecommended bool

+ MigrationMustBeDirect bool

+ Provider string

+ RuntimeMayBePooled bool

+ TLSRequired bool

+ type RegionEnablement struct

+ CanPrepareNewCellFromRepo bool

+ RequiresBootstrapData bool

+ RequiresDataCopy bool

+ RequiresProviderCaps []string

+ type RollbackPosture struct

+ AppRollbackCompatibleWithCurrentSchema bool

+ DBPosture string

+ Reason string

+ RequiresDatabaseRollback bool

+ type SQLClassification struct

+ Classification string

+ Reason string

+ Statement string

+ type SchemaSnapshot struct

+ Digest string

+ Path string

+ Required bool

+ type SourceValidationResult struct

+ CombinedDigest string

+ DeclarationValid bool

+ FilesParseable bool

+ OrderingValid bool

+ PathsValid bool

+ SecretsAbsent bool

+ type Topology struct

+ CellLocalReady bool

+ DefaultMode string

+ GlobalDatabaseReady bool

+ Partitioning Partitioning

+ SupportedModes []string

+ TenantHomeRegionReady bool

+ type UnsupportedValidationPhase struct

+ Executed bool

+ ProofLevel artifact.ProofLevel

+ Status string

+ Supported bool

+ UnsupportedReason string

+ type Validation struct

+ Analysis artifact.Analysis

+ App artifact.App

+ ArtifactID string

+ ArtifactKind string

+ Bindings []BindingValidation

+ ContractRef artifact.ArtifactRef

+ Diagnostics []artifact.Diagnostic

+ Inputs []artifact.ArtifactRef

+ Mode string

+ OperationReadiness []artifact.OperationReadiness

+ Outputs []artifact.ArtifactRef

+ Producer artifact.Producer

+ References map[string]artifact.ArtifactRef

+ SchemaVersion string

+ Summary ValidationSummary

+ func BuildValidation(opts BuildOptions, contract *Contract) (*Validation, error)

+ type ValidationOptions struct

+ ProjectRoot string

+ RequireArtifacts bool

+ type ValidationResult struct

+ Diagnostics []artifact.Diagnostic

+ Valid bool

+ func ValidateContract(c *Contract, opts ValidationOptions) ValidationResult

+ type ValidationSummary struct

+ BindingCount int

+ FailedBindings int

+ ManualRequiredCount int

+ PassedBindings int

+ Status string

+ WarningBindings int