Copyright 2022 The Cockroach Authors.

Package upgradecluster provides implementations of upgrade.Cluster.

Package upgradejob contains the jobs.Resumer implementation used for long-running upgrades.

Package upgrademanager provides an implementation of upgrade.Manager for use on kv nodes.

Package upgrades contains the implementation of upgrades.

BumpSystemDatabaseSchemaVersion bumps the SystemDatabaseSchemaVersion field for the system database descriptor.

NewSystemUpgrade constructs a SystemUpgrade.

NewTenantUpgrade constructs a TenantUpgrade.

RestoreActionImplemented is used to signal an upgrade migration affects state that is written by restore and has implemented the requisite logic in restore to perform the equivalent upgrade on restored data as it is restored.

RestoreActionNotRequired is used to signal an upgrade migration only affects persisted state that is not written by restore.

NoPrecondition can be used with NewTenantUpgrade to signify that the respective upgrade does not need any preconditions checked.

RestoreBehavior explains what the behavior of a given upgrade migration is during restoration of table, database or a cluster backups.

SystemDeps are the dependencies of upgrades which perform actions at the KV layer on behalf of the system tenant.

SystemUpgrade is an implementation of Upgrade for system-level upgrades.

TenantDeps are the dependencies of upgrades which perform actions at the SQL layer.

TenantUpgrade is an implementation of Upgrade for tenant-level upgrades.

Cluster abstracts a physical KV cluster and can be utilized by a long-running upgrade.

JobDeps are upgrade-specific dependencies used by the upgrade job to run upgrades.

PreconditionFunc is a function run without isolation before attempting an upgrade that includes this upgrade.

SystemUpgradeFunc is used to perform kv-level upgrades.

TenantUpgradeFunc is used to perform sql-level upgrades.