Enum mz_catalog::durable::objects::state_update::StateUpdateKind

pub enum StateUpdateKind {
    AuditLog(AuditLogKey, ()),
    Cluster(ClusterKey, ClusterValue),
    ClusterReplica(ClusterReplicaKey, ClusterReplicaValue),
    Comment(CommentKey, CommentValue),
    Config(ConfigKey, ConfigValue),
    Database(DatabaseKey, DatabaseValue),
    DefaultPrivilege(DefaultPrivilegesKey, DefaultPrivilegesValue),
    FenceToken(FenceToken),
    IdAllocator(IdAllocKey, IdAllocValue),
    IntrospectionSourceIndex(ClusterIntrospectionSourceIndexKey, ClusterIntrospectionSourceIndexValue),
    Item(ItemKey, ItemValue),
    NetworkPolicy(NetworkPolicyKey, NetworkPolicyValue),
    Role(RoleKey, RoleValue),
    Schema(SchemaKey, SchemaValue),
    Setting(SettingKey, SettingValue),
    SourceReferences(SourceReferencesKey, SourceReferencesValue),
    SystemConfiguration(ServerConfigurationKey, ServerConfigurationValue),
    SystemObjectMapping(GidMappingKey, GidMappingValue),
    SystemPrivilege(SystemPrivilegesKey, SystemPrivilegesValue),
    StorageCollectionMetadata(StorageCollectionMetadataKey, StorageCollectionMetadataValue),
    UnfinalizedShard(UnfinalizedShardKey, ()),
    TxnWalShard((), TxnWalShardValue),
}

The contents of a single state update.

The entire catalog is serialized as bytes and saved in a single persist shard. We use this enum to determine what collection something in the catalog belongs to.

Variants

AuditLog(AuditLogKey, ())

Cluster(ClusterKey, ClusterValue)

ClusterReplica(ClusterReplicaKey, ClusterReplicaValue)

Comment(CommentKey, CommentValue)

Config(ConfigKey, ConfigValue)

Database(DatabaseKey, DatabaseValue)

DefaultPrivilege(DefaultPrivilegesKey, DefaultPrivilegesValue)

FenceToken(FenceToken)

IdAllocator(IdAllocKey, IdAllocValue)

IntrospectionSourceIndex(ClusterIntrospectionSourceIndexKey, ClusterIntrospectionSourceIndexValue)

Item(ItemKey, ItemValue)

NetworkPolicy(NetworkPolicyKey, NetworkPolicyValue)

Role(RoleKey, RoleValue)

Schema(SchemaKey, SchemaValue)

Setting(SettingKey, SettingValue)

SourceReferences(SourceReferencesKey, SourceReferencesValue)

SystemConfiguration(ServerConfigurationKey, ServerConfigurationValue)

SystemObjectMapping(GidMappingKey, GidMappingValue)

SystemPrivilege(SystemPrivilegesKey, SystemPrivilegesValue)

StorageCollectionMetadata(StorageCollectionMetadataKey, StorageCollectionMetadataValue)

UnfinalizedShard(UnfinalizedShardKey, ())

TxnWalShard((), TxnWalShardValue)

Implementations

impl StateUpdateKind

pub(crate) fn collection_type(&self) -> Option<CollectionType>

Trait Implementations

impl ApplyUpdate<StateUpdateKind> for CatalogStateInner

fn apply_update( &mut self, update: StateUpdate<StateUpdateKind>, current_fence_token: &mut FenceableToken, metrics: &Arc<Metrics>, ) -> Result<Option<StateUpdate<StateUpdateKind>>, FenceError>

Process and apply update.

impl Arbitrary for StateUpdateKind

type Parameters = ((<AuditLogKey as Arbitrary>::Parameters, <() as Arbitrary>::Parameters), (<ClusterKey as Arbitrary>::Parameters, <ClusterValue as Arbitrary>::Parameters), (<ClusterReplicaKey as Arbitrary>::Parameters, <ClusterReplicaValue as Arbitrary>::Parameters), (<CommentKey as Arbitrary>::Parameters, <CommentValue as Arbitrary>::Parameters), (<ConfigKey as Arbitrary>::Parameters, <ConfigValue as Arbitrary>::Parameters), (<DatabaseKey as Arbitrary>::Parameters, <DatabaseValue as Arbitrary>::Parameters), (<DefaultPrivilegesKey as Arbitrary>::Parameters, <DefaultPrivilegesValue as Arbitrary>::Parameters), <FenceToken as Arbitrary>::Parameters, (<IdAllocKey as Arbitrary>::Parameters, <IdAllocValue as Arbitrary>::Parameters), ((<ClusterIntrospectionSourceIndexKey as Arbitrary>::Parameters, <ClusterIntrospectionSourceIndexValue as Arbitrary>::Parameters), (<ItemKey as Arbitrary>::Parameters, <ItemValue as Arbitrary>::Parameters), (<NetworkPolicyKey as Arbitrary>::Parameters, <NetworkPolicyValue as Arbitrary>::Parameters), (<RoleKey as Arbitrary>::Parameters, <RoleValue as Arbitrary>::Parameters), (<SchemaKey as Arbitrary>::Parameters, <SchemaValue as Arbitrary>::Parameters), (<SettingKey as Arbitrary>::Parameters, <SettingValue as Arbitrary>::Parameters), (<SourceReferencesKey as Arbitrary>::Parameters, <SourceReferencesValue as Arbitrary>::Parameters), (<ServerConfigurationKey as Arbitrary>::Parameters, <ServerConfigurationValue as Arbitrary>::Parameters), (<GidMappingKey as Arbitrary>::Parameters, <GidMappingValue as Arbitrary>::Parameters), ((<SystemPrivilegesKey as Arbitrary>::Parameters, <SystemPrivilegesValue as Arbitrary>::Parameters), (<StorageCollectionMetadataKey as Arbitrary>::Parameters, <StorageCollectionMetadataValue as Arbitrary>::Parameters), (<UnfinalizedShardKey as Arbitrary>::Parameters, <() as Arbitrary>::Parameters), (<() as Arbitrary>::Parameters, <TxnWalShardValue as Arbitrary>::Parameters))))

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Union<BoxedStrategy<StateUpdateKind>>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for StateUpdateKind

fn clone(&self) -> StateUpdateKind

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StateUpdateKind

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<StateUpdateKind> for StateUpdateKindJson

fn from(value: StateUpdateKind) -> Self

Converts to this type from the input type.

impl Ord for StateUpdateKind

fn cmp(&self, other: &StateUpdateKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for StateUpdateKind

fn eq(&self, other: &StateUpdateKind) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for StateUpdateKind

fn partial_cmp(&self, other: &StateUpdateKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RustType<StateUpdateKind> for StateUpdateKind

fn into_proto(&self) -> StateUpdateKind

Convert a Self into a Proto value.

fn into_proto_owned(self) -> StateUpdateKind

A zero clone version of Self::into_proto that types can optionally implement, otherwise, the default implementation delegates to Self::into_proto.

fn from_proto( proto: StateUpdateKind, ) -> Result<StateUpdateKind, TryFromProtoError>

Consume and convert a Proto back into a Self value.

impl TryFrom<&StateUpdateKind> for Option<StateUpdateKind>

type Error = DurableCatalogError

The type returned in the event of a conversion error.

fn try_from(kind: &StateUpdateKind) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&StateUpdateKindJson> for StateUpdateKind

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: &StateUpdateKindJson) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<StateUpdateKindJson> for StateUpdateKind

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: StateUpdateKindJson) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for StateUpdateKind

impl StructuralPartialEq for StateUpdateKind