migration

Documentation

Index

• type ExposedClusterVersion
  • func NewDefaultExposedClusterVersion(engines []engine.Engine) *ExposedClusterVersion
  • func NewExposedClusterVersion(getter func() base.ClusterVersion, engines []engine.Engine) *ExposedClusterVersion
  • func (ecv *ExposedClusterVersion) IsActive(v roachpb.Version) bool
  • func (ecv *ExposedClusterVersion) Version() base.ClusterVersion

Types

type ExposedClusterVersion

type ExposedClusterVersion struct {
	// contains filtered or unexported fields
}

ExposedClusterVersion manages the active version of a running node.

func NewDefaultExposedClusterVersion

func NewDefaultExposedClusterVersion(engines []engine.Engine) *ExposedClusterVersion

NewDefaultExposedClusterVersion returns an *ExposedClusterVersion which takes its updates from the global version cluster setting.

func NewExposedClusterVersion

func NewExposedClusterVersion(
	getter func() base.ClusterVersion, engines []engine.Engine,
) *ExposedClusterVersion

NewExposedClusterVersion initializes an ExposedClusterVersion which takes into account the gossiped cluster version (if any) and the cluster version (if any) persisted on the given engines, and updates the engines as the cluster-wide version is bumped before exposing these new versions.

While this variable might hold a stale value (owing to the fact that the source of truth may not be local to the node), the MinimumVersion represented by it does not decrease.

func (*ExposedClusterVersion) IsActive

func (ecv *ExposedClusterVersion) IsActive(v roachpb.Version) bool

IsActive returns true if the features of the supplied version are active at the running version.

func (*ExposedClusterVersion) Version

func (ecv *ExposedClusterVersion) Version() base.ClusterVersion

Version returns the minimum cluster version the caller may assume is in effect.