Struct mz_adapter::catalog::Cluster

pub struct Cluster {
    pub name: String,
    pub id: StorageInstanceId,
    pub config: ClusterConfig,
    pub log_indexes: BTreeMap<LogVariant, GlobalId>,
    pub linked_object_id: Option<GlobalId>,
    pub bound_objects: BTreeSet<GlobalId>,
    pub replica_id_by_name_: BTreeMap<String, ReplicaId>,
    pub replicas_by_id_: BTreeMap<ReplicaId, ClusterReplica>,
    pub owner_id: RoleId,
    pub privileges: PrivilegeMap,
}

Fields

name: String

id: StorageInstanceId

config: ClusterConfig

log_indexes: BTreeMap<LogVariant, GlobalId>

linked_object_id: Option<GlobalId>

bound_objects: BTreeSet<GlobalId>

Objects bound to this cluster. Does not include introspection source indexes.

replica_id_by_name_: BTreeMap<String, ReplicaId>

replicas_by_id_: BTreeMap<ReplicaId, ClusterReplica>

owner_id: RoleId

privileges: PrivilegeMap

Implementations

impl Cluster

pub fn role(&self) -> ClusterRole

The role of the cluster. Currently used to set alert severity.

pub fn is_managed(&self) -> bool

Returns true if the cluster is a managed cluster.

pub fn user_replicas(&self) -> impl Iterator<Item = &ClusterReplica>

Lists the user replicas, which are those that do not have the internal flag set.

pub fn replicas(&self) -> impl Iterator<Item = &ClusterReplica>

Lists all replicas in the cluster

pub fn replica(&self, replica_id: ReplicaId) -> Option<&ClusterReplica>

Lookup a replica by ID.

pub fn replica_mut( &mut self, replica_id: ReplicaId ) -> Option<&mut ClusterReplica>

Lookup a replica by ID and return a mutable reference.

pub fn replica_id(&self, name: &str) -> Option<ReplicaId>

Lookup a replica ID by name.

pub fn insert_replica(&mut self, replica: ClusterReplica)

Insert a new replica into the cluster.

Panics if the name or ID are reused.

pub fn remove_replica(&mut self, replica_id: ReplicaId)

Remove a replica from this cluster.

Panics if the replica ID does not exist, or if the internal state is inconsistent.

pub fn rename_replica(&mut self, replica_id: ReplicaId, to_name: String)

Renames a replica to a new name.

Panics if the replica ID is unknown, or new name is not unique, or the internal state is inconsistent.

Trait Implementations

impl CatalogCluster<'_> for Cluster

fn name(&self) -> &str

Returns a fully-specified name of the cluster.

fn id(&self) -> StorageInstanceId

Returns a stable ID for the cluster.

fn linked_object_id(&self) -> Option<GlobalId>

Returns the ID of the object this cluster is linked to, if any.

fn bound_objects(&self) -> &BTreeSet<GlobalId>

Returns the objects that are bound to this cluster.

fn replica_ids(&self) -> &BTreeMap<String, ReplicaId>

Returns the replicas of the cluster as a map from replica name to replica ID.

fn replicas(&self) -> Vec<&dyn CatalogClusterReplica<'_>>

Returns the replicas of the cluster.

fn replica(&self, id: ReplicaId) -> &dyn CatalogClusterReplica<'_>

Returns the replica belonging to the cluster with replica ID id.

fn owner_id(&self) -> RoleId

Returns the ID of the owning role.

fn privileges(&self) -> &PrivilegeMap

Returns the privileges associated with the cluster.

fn is_managed(&self) -> bool

Returns true if this cluster is a managed cluster.

impl Clone for Cluster

fn clone(&self) -> Cluster

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cluster

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

Formats the value using the given formatter.

impl Serialize for Cluster

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.