package
20.2.19+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev

# Functions

CountUserDescriptors returns the number of descriptors present that were created by the user (i.e.
GenerateUniqueDescID returns the next available Descriptor ID and increments the counter.
GetAllDatabaseDescriptorIDs looks up and returns all available database descriptor IDs.
GetAllDescriptors looks up and returns all available descriptors.
GetAnyDescriptorByID is a wrapper around GetDescriptorByID which permits missing descriptors and does not restrict the requested kind.
GetDatabaseDescByID looks up the database descriptor given its ID, returning nil if the descriptor is not found.
GetDatabaseDescriptorsFromIDs returns the database descriptors from an input set of database IDs.
GetDatabaseID resolves a database name into a database ID.
GetDescriptorByID looks up the descriptor for `id`.
GetDescriptorID looks up the ID for plainKey.
GetSchemaDescriptorsFromIDs returns the schema descriptors from an input list of schema IDs.
LookupDatabaseID is a wrapper around LookupObjectID for databases.
LookupObjectID returns the ObjectID for the given (parentID, parentSchemaID, name) supplied.
LookupPublicTableID is a wrapper around LookupObjectID for public tables.
MakeDatabaseNameKey is a wrapper around MakeObjectNameKey for databases.
MakeObjectNameKey returns a key in the system.namespace table for a given parentID and name, based on the cluster version.
MakePublicTableNameKey is a wrapper around MakeObjectNameKey for public tables.
MustGetDatabaseDescByID looks up the database descriptor given its ID, returning an error if the descriptor is not found.
MustGetSchemaDescByID looks up the schema descriptor given its ID, returning an error if the descriptor is not found.
MustGetTableDescByID looks up the table descriptor given its ID, returning an error if the table is not found.
NewOneLevelUncachedDescGetter returns a new DescGetter backed by the passed Txn.
RemoveDatabaseNamespaceEntry is a wrapper around RemoveObjectNamespaceEntry for databases.
RemoveObjectNamespaceEntry removes entries from both the deprecated and new system.namespace table (if one exists).
RemoveSchemaNamespaceEntry is a wrapper around RemoveObjectNamespaceEntry for schemas.
ResolveSchemaID resolves a schema's ID based on db and name.
TestingGetDatabaseDescriptor retrieves a database descriptor directly from the kv layer.
TestingGetImmutableTableDescriptor retrieves an immutable table descriptor directly from the KV layer.
TestingGetMutableExistingTableDescriptor retrieves a Mutable directly from the KV layer.
TestingGetSchemaDescriptor retrieves a schema descriptor directly from the kv layer.
TestingGetTableDescriptor retrieves a table descriptor directly from the KV layer.
TestingGetTableDescriptorFromSchema retrieves a table descriptor directly from the KV layer.
TestingGetTypeDescriptor retrieves a type descriptor directly from the kv layer.
TestingGetTypeDescriptorFromSchema retrieves a type descriptor directly from the KV layer.
UnwrapDescriptorRaw takes a descriptor retrieved from a backup manifest or as input to the sql doctor and constructs the appropriate MutableDescriptor object implied by that object.
WriteDescToBatch adds a Put command writing a descriptor proto to the descriptors table.
WriteNewDescToBatch adds a CPut command writing a descriptor proto to the descriptors table.
WriteObjectNamespaceEntryRemovalToBatch writes Del operations to b for both the deprecated and new system.namespace table (if one exists).

# Constants

permit any kind.
List of DescriptorKind values.
Mutability values.
Mutability values.
List of DescriptorKind values.
List of DescriptorKind values.
List of DescriptorKind values.

# Structs

UncachedPhysicalAccessor implements direct access to sql object descriptors stored in system tables without any kind of caching.

# Type aliases

DescriptorKind is used to indicate the desired kind of descriptor from GetDescriptorByID.
Mutability indicates whether the desired descriptor is mutable.