Module objects 

The current types used to represent catalog data stored on disk. These objects generally fall into two categories.

The key-value objects are a one-to-one mapping of the protobuf objects used to save catalog data durably. They can be converted to and from protobuf via the RustType trait. These objects should not be exposed anywhere outside the crate::durable module.

The other type of objects combine the information from keys and values into a single struct, but are still a direct representation of the data stored on disk. They can be converted to and from the key-value objects via the DurableType trait. These objects are used to pass information to other modules in this crate and other catalog related code.

All non-catalog code should interact with the objects in crate::memory::objects and never directly interact with the objects in this module.

As an example, DatabaseKey and DatabaseValue are key-value objects, while Database is the non-key-value counterpart.

Modules

serialization

This module is responsible for serializing catalog objects into Protobuf.

Structs

AuditLog

AuditLogKey

BurstState

An active hydration burst the controller is running.

Cluster

ClusterConfig

ClusterIntrospectionSourceIndexKey

ClusterIntrospectionSourceIndexValue

ClusterKey

ClusterReplica

ClusterReplicaKey

ClusterReplicaValue

ClusterSystemConfiguration

A single cluster-coherent scoped system-parameter override: parameter name has value value on the cluster cluster_id.

ClusterSystemConfigurationKey

ClusterSystemConfigurationValue

ClusterValue

ClusterVariantManaged

Comment

CommentKey

CommentValue

Config

ConfigKey

ConfigValue

Database

DatabaseKey

DatabaseValue

DefaultPrivilege

DefaultPrivilegesKey

DefaultPrivilegesValue

FenceToken

Token used to fence out other processes.

GidMappingKey

GidMappingValue

IdAlloc

IdAllocKey

IdAllocValue

IntrospectionSourceIndex

IntrospectionSourceIndexCatalogItemId

A newtype wrapper for CatalogItemId that is only for the “introspection source index” namespace.

IntrospectionSourceIndexGlobalId

A newtype wrapper for GlobalId that is only for the “introspection source index” namespace.

Item

ItemKey

ItemValue

NetworkPolicy

NetworkPolicyKey

NetworkPolicyValue

ReconfigurationState

The latest graceful reconfiguration: the config shape the cluster is moving to or most recently moved toward, plus its deadline and terminal state.

ReconfigurationTarget

The full config shape a reconfiguration is moving the cluster to, so a combined size + replication-factor + availability-zone change is one record.

ReplicaConfig

ReplicaSystemConfiguration

A single replica-local scoped system-parameter override: parameter name has value value on the replica replica_id.

ReplicaSystemConfigurationKey

ReplicaSystemConfigurationValue

Role

RoleAuth

RoleAuthKey

RoleAuthValue

RoleKey

RoleValue

Schema

SchemaKey

SchemaValue

ServerConfigurationKey

ServerConfigurationValue

Setting

SettingKey

SettingValue

Snapshot

A snapshot of the current on-disk state.

SourceReference

SourceReferences

SourceReferencesKey

SourceReferencesValue

StorageCollectionMetadata

StorageCollectionMetadataKey

StorageCollectionMetadataValue

This value is stored transparently, however, it should only ever be manipulated by the storage controller.

SystemCatalogItemId

A newtype wrapper for CatalogItemId that is only for the “system” namespace.

SystemConfiguration

SystemGlobalId

A newtype wrapper for GlobalId that is only for the “system” namespace.

SystemObjectDescription

SystemObjectMapping

Functions can share the same name as any other catalog item type within a given schema. For example, a function can have the same name as a type, e.g. ‘date’. As such, system objects are keyed in the catalog storage by the tuple (schema_name, object_type, object_name), which is guaranteed to be unique.

SystemObjectUniqueIdentifier

SystemPrivilegesKey

SystemPrivilegesValue

TxnWalShardValue

This value is stored transparently, however, it should only ever be manipulated by the storage controller.

UnfinalizedShard

UnfinalizedShardKey

This value is stored transparently, however, it should only ever be manipulated by the storage controller.

Enums

ClusterVariant

ReconfigurationStatus

The lifecycle status of the latest graceful reconfiguration.

ReplicaLocation

Traits

DurableType

A trait for representing Self as a key-value pair of type (Key, Value) for the purpose of storing this value durably.

Functions

item_type

managed_cluster_replica_name

The canonical name of the index-th (zero-based) replica of a managed cluster.