Expand description
This crate is responsible for durably storing and modifying the catalog contents.
Re-exports§
pub use crate::durable::objects::Cluster;pub use crate::durable::objects::ClusterConfig;pub use crate::durable::objects::ClusterReplica;pub use crate::durable::objects::ClusterVariant;pub use crate::durable::objects::ClusterVariantManaged;pub use crate::durable::objects::Comment;pub use crate::durable::objects::Database;pub use crate::durable::objects::DefaultPrivilege;pub use crate::durable::objects::IntrospectionSourceIndex;pub use crate::durable::objects::Item;pub use crate::durable::objects::NetworkPolicy;pub use crate::durable::objects::ReplicaConfig;pub use crate::durable::objects::ReplicaLocation;pub use crate::durable::objects::Role;pub use crate::durable::objects::RoleAuth;pub use crate::durable::objects::Schema;pub use crate::durable::objects::SourceReference;pub use crate::durable::objects::SourceReferences;pub use crate::durable::objects::StorageCollectionMetadata;pub use crate::durable::objects::SystemConfiguration;pub use crate::durable::objects::SystemObjectDescription;pub use crate::durable::objects::SystemObjectMapping;pub use crate::durable::objects::UnfinalizedShard;
Modules§
- debug
- Functionality for manually modifying and displaying the catalog contents. This is helpful for fixing a corrupt catalog.
- error 🔒
- initialize
- metrics 🔒
- Prometheus monitoring metrics.
- objects
- The current types used to represent catalog data stored on disk. These objects generally fall into two categories.
- persist 🔒
- traits 🔒
- transaction 🔒
- upgrade 🔒
- This module contains all the helpers and code paths for upgrading/migrating the
Catalog.
Structs§
- Audit
LogIterator - An iterator that returns audit log events in reverse ID order.
- Bootstrap
Args - Metrics
- State
Update - A single update to the catalog state.
- Test
Catalog State Builder - A builder to help create an
OpenableDurableCatalogStatefor tests. - Transaction
- A
Transactionbatches multiple catalog operations together and commits them atomically. An operation also logically groups multiple catalog updates together.
Enums§
- Catalog
Error - Durable
Catalog Error - An error that can occur while interacting with a durable catalog.
- Fence
Error - An error that indicates the durable catalog has been fenced.
Constants§
- AUDIT_
LOG_ ID_ ALLOC_ KEY - BUILTIN_
MIGRATION_ SHARD_ KEY - CATALOG_
CONTENT_ 🔒VERSION_ KEY - CATALOG_
VERSION - The current version of the
Catalog. The current version of theCatalog. - DATABASE_
ID_ ALLOC_ KEY - EXPRESSION_
CACHE_ SHARD_ KEY - OID_
ALLOC_ KEY - SCHEMA_
ID_ ALLOC_ KEY - STORAGE_
USAGE_ ID_ ALLOC_ KEY - SYSTEM_
CLUSTER_ ID_ ALLOC_ KEY - SYSTEM_
ITEM_ ALLOC_ KEY - SYSTEM_
REPLICA_ ID_ ALLOC_ KEY - USER_
CLUSTER_ ID_ ALLOC_ KEY - USER_
ITEM_ ALLOC_ KEY - USER_
NETWORK_ POLICY_ ID_ ALLOC_ KEY - USER_
REPLICA_ ID_ ALLOC_ KEY - USER_
ROLE_ ID_ ALLOC_ KEY
Traits§
- Audit
LogIterator 🔒Trait - Durable
Catalog State - A read-write API for the durable catalog state.
- Openable
Durable Catalog State - An API for opening a durable catalog state.
- Read
Only Durable Catalog State - A read only API for the durable catalog state.
Functions§
- persist_
backed_ catalog_ state - Creates an openable durable catalog state implemented using persist.
- shard_
id - Deterministically generate a shard ID for the given
organization_idandseed. - test_
bootstrap_ args