package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Packages
Package backfiller contains logic for reading, writing, and tracking backfiller progress.
# Functions
ExecuteStage executes the provided ops.
MakeDeclarativeSchemaChangeJobRecord is used to construct a declarative schema change job.
MakeMergeProgress constructs a new MergeProgress for a merge with an empty set of CompletedSpans.
# Structs
Backfill corresponds to a definition of a backfill from a source index into multiple destination indexes.
BackfillProgress tracks the progress for a Backfill.
Merge corresponds to a definition of a merge from multiple temporary indexes into adding indexes.
MergeProgress tracks the progress for a Merge.
TestingKnobs are testing knobs which affect the running of declarative schema changes.
# Interfaces
Backfiller is an abstract index backfiller that performs index backfills when provided with a specification of tables and indexes and a way to track job progress.
BackfillerProgressFlusher is used to flush backfill and merge progress state to the underlying store.
BackfillerProgressReader is used by the backfill execution layer to read backfill and merge progress.
BackfillerProgressWriter is used by the backfiller to write out progress updates.
BackfillerTracker abstracts the infrastructure to read and write backfill and merge progress to job state.
Catalog encapsulates the catalog-related dependencies for the executor.
Dependencies contains all the dependencies required by the executor.
DescriptorMetadataUpdater is used to update metadata associated with schema objects, for example comments associated with a schema.
IndexSpanSplitter can try to split an index span in the current transaction prior to backfilling.
Merger is an abstract index merger that performs index merges when provided with a specification of tables and indexes and a way to track job progress.
PeriodicProgressFlusher is used to write updates to backfill progress periodically.
ProtectedTimestampManager used to install a protected timestamp before the GC interval is encountered.
StatsRefresher responsible for refreshing table stats.
StatsRefreshQueue queues table for stats refreshes.
Telemetry encapsulates metrics gather for the declarative schema changer.
TransactionalJobRegistry creates and updates jobs in the current transaction.
Validator provides interfaces that allow indexes and check constraints to be validated.
# Type aliases
JobUpdateCallback is for updating a job.