migration

type Artifact struct {
	// Version identifies this Ridu artifact JSON format.
	Version uint32 `json:"version"`
	// Name is the lowercase author-supplied migration name.
	Name string `json:"name"`
	// Planner records the exact planner and version used at creation.
	Planner Planner `json:"planner"`
	// MinimumRunnerContract is the lowest execution contract that may run
	// every phase and executor in this artifact.
	MinimumRunnerContract uint32 `json:"minimumRunnerContract,omitempty"`
	// PreviousArtifactDigest binds this artifact to the exact preceding artifact,
	// including data-only transitions whose manifest digest does not change.
	// It is empty only for the initial artifact.
	PreviousArtifactDigest string `json:"previousArtifactDigest"`
	// FromDigest and ToDigest establish immutable manifest lineage.
	FromDigest string `json:"fromDigest"`
	ToDigest   string `json:"toDigest"`
	// Before is absent only for an initial migration from an empty schema.
	Before *schema.Snapshot `json:"before,omitempty"`
	// After is the complete desired manifest after every step succeeds.
	After schema.Snapshot `json:"after"`
	// Phases are the resumable execution plan.
	Phases []Phase `json:"phases"`
	// Risks retains machine-readable planner and linter findings for review.
	Risks []Risk `json:"risks"`
}

type ArtifactIdentity struct {
	Name   string `json:"name"`
	Digest string `json:"digest"`
}

type AssertSchemaPayload struct{}

type AuditRequiredValuesPayload struct {
	Fields []RequiredFieldAddress `json:"fields"`
}

type BackfillReferencesPayload struct {
	BatchSize uint32 `json:"batchSize"`
}

type BaselineReplacementOptions struct {
	PreviousDirectory string
	// AllowProduction permits rewriting the history of a database that is
	// exactly at its recorded head, where binaries built from that history may
	// still pass readiness. Stop every application process and writer first.
	AllowProduction bool
}

type ConcurrentIndexAction string

type ConcurrentIndexPayload struct {
	Action    ConcurrentIndexAction `json:"action"`
	Name      string                `json:"name"`
	Table     string                `json:"table,omitempty"`
	Unique    bool                  `json:"unique,omitempty"`
	Method    string                `json:"method,omitempty"`
	Parts     []string              `json:"parts,omitempty"`
	Predicate string                `json:"predicate,omitempty"`
}

type DataTransaction interface {
	// Collection returns the collection with this slug as the running
	// migration leaves it, or as it was before when the migration removes it.
	// Every request must use a shape from the migration itself, so a
	// transform keeps replaying after later migrations change the collection.
	Collection(slug string) (schema.Collection, error)
	// Global returns the global with this slug, resolved like Collection.
	Global(slug string) (schema.Collection, error)
	Create(context.Context, store.CreateRequest) (store.Document, error)
	Find(context.Context, store.Request) (store.Document, error)
	List(context.Context, store.Request) (store.Page, error)
	Update(context.Context, UpdateRequest) (store.Document, error)
	Trash(context.Context, store.Request) (store.Document, error)
	Restore(context.Context, store.Request) (store.Document, error)
	Delete(context.Context, store.Request) (store.Document, error)
}

type DataTransform struct {
	DataTransformDescriptor
	Up   DataTransformCallback
	Down DataTransformCallback
}

type DataTransformCallback func(context.Context, DataTransaction) error

type DataTransformDescriptor struct {
	Name     string `json:"name"`
	Checksum string `json:"checksum"`
}

type DataTransformPayload struct {
	Transform DataTransformDescriptor `json:"transform"`
}

type FieldRename struct {
	// Before is the canonical field path in the before manifest.
	Before string `json:"before"`
	// After is the canonical field path in the after manifest.
	After string `json:"after"`
}

type MongoDBCreateIndexPayload struct {
	Collection string `json:"collection"`
	Index      string `json:"index"`
}

type MongoDBDropIndexPayload struct {
	CollectionID schema.StableID `json:"collectionId"`
	Version      bool            `json:"version,omitempty"`
	Published    bool            `json:"published,omitempty"`
	Index        string          `json:"index"`
}

type MongoDBDropResourcesPayload struct {
	ResourceIDs []schema.StableID `json:"resourceIds"`
}

type MongoDBRenameResourcePayload struct {
	BeforeID schema.StableID `json:"beforeId"`
	AfterID  schema.StableID `json:"afterId"`
}

type Operation struct {
	// Kind selects the runner behavior.
	Kind StepKind `json:"kind"`
	// Name is a stable, review-friendly operation label.
	Name string `json:"name"`
	// SQL is present only for StepSQL.
	SQL string `json:"sql,omitempty"`
	// Rename is present only for StepRenameContent.
	Rename *Rename `json:"rename,omitempty"`
	// ResourceIDs is present only while planning a StepRetireResources step.
	ResourceIDs []schema.StableID `json:"resourceIds,omitempty"`
	// PurgeVersionOwnerIDs identifies surviving resources whose complete
	// historical version rows could otherwise restore references to a retired
	// resource. It is present only while planning StepRetireResources.
	PurgeVersionOwnerIDs []schema.StableID `json:"purgeVersionOwnerIds,omitempty"`
	// RequiredFields is present only for StepAuditRequiredValues.
	RequiredFields []RequiredFieldAddress `json:"requiredFields,omitempty"`
}

type Phase struct {
	ID                      string    `json:"id"`
	Mode                    PhaseMode `json:"mode"`
	PhysicalContractVersion uint32    `json:"physicalContractVersion"`
	BeforePhysicalDigest    string    `json:"beforePhysicalDigest"`
	AfterPhysicalDigest     string    `json:"afterPhysicalDigest"`
	Steps                   []Step    `json:"steps"`
}

type PhaseMode string

type Planner struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

type ProjectAction string

type ProjectDriver interface {
	// Validate checks the complete executable registration before a project
	// command resolves config or changes database state.
	Validate() error
	DataTransforms() []DataTransformDescriptor
	// RunProjectMigration receives the exact manifest resolved by the process
	// that will execute the request. The driver must validate it against the
	// selected artifact history before opening or changing the database.
	RunProjectMigration(context.Context, ProjectRequest, schema.Manifest) error
}

type ProjectRequest struct {
	Action                 ProjectAction
	DatabasePath           string
	DatabaseURL            string
	Directory              string
	AllowInsecureDatabase  bool
	AllowMaintenance       bool
	AllowUnbounded         bool
	LockWait               time.Duration
	OperationTimeout       time.Duration
	LockTimeout            time.Duration
	StatementTimeout       time.Duration
	BatchTimeout           time.Duration
	IdleTransactionTimeout time.Duration
	StopAfterPhase         string
	StopAfterStep          string
}

type Rename struct {
	// CollectionBefore and CollectionAfter are current public slugs. Both are
	// empty for a block field rename.
	CollectionBefore schema.CollectionSlug `json:"collectionBefore,omitempty"`
	CollectionAfter  schema.CollectionSlug `json:"collectionAfter,omitempty"`
	// Block names the block definition whose field is renamed. The definition
	// is shared, so the rename moves the field's content in every stored block
	// of it, in every resource and version snapshot.
	Block string `json:"block,omitempty"`
	// FieldBefore and FieldAfter are canonical field paths, relative to Block
	// for a block field rename. Empty paths mean the rename applies to the
	// collection itself.
	FieldBefore string `json:"fieldBefore,omitempty"`
	FieldAfter  string `json:"fieldAfter,omitempty"`
	// Fields records every nested or top-level field path whose identity changed
	// as part of a collection rename.
	Fields []FieldRename `json:"fields,omitempty"`
}

type RenamePayload struct {
	Rename Rename `json:"rename"`
}

type RequiredFieldAddress struct {
	ResourceID schema.StableID `json:"resourceId,omitempty"`
	Path       string          `json:"path"`
	Scope      string          `json:"scope,omitempty"`
}

type RetireResourcesPayload struct {
	ResourceIDs          []schema.StableID `json:"resourceIds"`
	PurgeVersionOwnerIDs []schema.StableID `json:"purgeVersionOwnerIds,omitempty"`
}

type Risk struct {
	// Code is a stable identifier suitable for CI policy.
	Code string `json:"code"`
	// Level classifies whether the finding is informational, risky, or destructive.
	Level RiskLevel `json:"level"`
	// Message explains the concrete impact and required review.
	Message string `json:"message"`
}

type RiskLevel string

type SQLPayload struct {
	SQL string `json:"sql"`
}

type Step struct {
	ID              string          `json:"id"`
	Kind            StepKind        `json:"kind"`
	ExecutorVersion uint32          `json:"executorVersion"`
	Name            string          `json:"name"`
	Payload         json.RawMessage `json:"payload"`
}

type StepKind string

type UpdateRequest struct {
	store.Request
	Values        store.Values
	ReplaceValues bool
}