package
19.2.12+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
DecodeKeyIntoZoneIDAndSuffix figures out the zone that the key belongs to.
DecodeObjectID decodes the object ID from the front of key.
DefaultSystemZoneConfig is the default zone configuration used when no custom config has been specified.
DefaultSystemZoneConfigRef is the default zone configuration used when no custom config has been specified.
DefaultZoneConfig is the default zone configuration used when no custom config has been specified.
DefaultZoneConfigRef is the default zone configuration used when no custom config has been specified.
EmptyCompleteZoneConfig is the zone configuration where all fields are set but set to their respective zero values.
MakeZoneKey returns the key for id's entry in the system.zones table.
MakeZoneKeyPrefix returns the key prefix for id's row in the system.zones table.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewSystemConfig returns an initialized instance of SystemConfig.
NewZoneConfig is the zone configuration used when no custom config has been specified.
ResolveZoneSpecifier converts a zone specifier to the ID of most specific zone whose config applies.
StaticSplits are predefined split points in the system keyspace.
StoreMatchesConstraint returns whether a store's attributes or node's locality match the constraint's spec.
StoreSatisfiesConstraint checks whether a store satisfies the given constraint.
TestingSetupZoneConfigHook initializes the zone config hook to 'testingZoneConfigHook' which uses 'testingZoneConfig'.
TestingSetZoneConfig sets the zone config entry for object 'id' in the testing map.
ZoneSpecifierFromID creates a tree.ZoneSpecifier for the zone with the given ID.
# Constants
DEPRECATED_POSITIVE has no effect on a replica's placement.
PROHIBITED will prevent replicas from having this key, value.
REQUIRED ensures all replicas are placed on stores that match the constraint.
Several ranges outside of the SQL keyspace are given special names so they can be targeted by zone configs.
Several ranges outside of the SQL keyspace are given special names so they can be targeted by zone configs.
Several ranges outside of the SQL keyspace are given special names so they can be targeted by zone configs.
Several ranges outside of the SQL keyspace are given special names so they can be targeted by zone configs.
Several ranges outside of the SQL keyspace are given special names so they can be targeted by zone configs.
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NamedZones maps named zones to their pseudo-table ID that can be used to install an entry into the system.zones table.
NamedZonesByID is the inverse of NamedZones: it maps pseudo-table IDs to their zone names.
SplitAtIDHook is a function that is used to check if a given descriptor comes from a database or a table view.
ZoneConfigHook is a function used to lookup a zone config given a table or database ID.
# Structs
Constraint constrains the stores a replica can be stored on.
Constraints is a collection of constraints.
ConstraintsList is an alias for a slice of Constraints that can be properly marshaled to/from YAML.
GCPolicy defines garbage collection policies which apply to MVCC values within a zone.
LeasePreference specifies a preference about where range leases should be located.
No description provided by the author
No description provided by the author
SystemConfig embeds a SystemConfigEntries message which contains an entry for every system descriptor (e.g.
No description provided by the author
ZoneConfig holds configuration that applies to one or more ranges.
# Type aliases
No description provided by the author