Trait mz_sql::catalog::CatalogCluster

pub trait CatalogCluster<'a> {
    // Required methods
    fn name(&self) -> &str;
    fn id(&self) -> ClusterId;
    fn bound_objects(&self) -> &BTreeSet<CatalogItemId>;
    fn replica_ids(&self) -> &BTreeMap<String, ReplicaId>;
    fn replicas(&self) -> Vec<&dyn CatalogClusterReplica<'_>>;
    fn replica(&self, id: ReplicaId) -> &dyn CatalogClusterReplica<'_>;
    fn owner_id(&self) -> RoleId;
    fn privileges(&self) -> &PrivilegeMap;
    fn is_managed(&self) -> bool;
    fn managed_size(&self) -> Option<&str>;
    fn schedule(&self) -> Option<&ClusterSchedule>;
    fn try_to_plan(&self) -> Result<CreateClusterPlan, PlanError>;
}

A cluster in a SessionCatalog.

Required Methods

fn name(&self) -> &str

Returns a fully-specified name of the cluster.

fn id(&self) -> ClusterId

Returns a stable ID for the cluster.

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

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.

fn managed_size(&self) -> Option<&str>

Returns the size of the cluster, if the cluster is a managed cluster.

fn schedule(&self) -> Option<&ClusterSchedule>

Returns the schedule of the cluster, if the cluster is a managed cluster.

fn try_to_plan(&self) -> Result<CreateClusterPlan, PlanError>

Try to convert this cluster into a CreateClusterPlan.

Implementors