Skip to main content

RoutingTable

Struct RoutingTable 

Source
pub struct RoutingTable { /* private fields */ }
Expand description

Maps vShards to Raft groups and Raft groups to nodes.

The 1024 vShards are divided into distinct Raft Groups (e.g., vShards 0-63 managed by Raft Group 1 across Nodes A, B, and C).

This table is the authoritative routing source. It is updated atomically via Raft state machine when:

  • A shard migration completes (Phase 3 atomic cut-over)
  • A Raft group membership changes
  • A node joins or decommissions

Implementations§

Source§

impl RoutingTable

Source

pub fn uniform( num_groups: u64, nodes: &[u64], replication_factor: usize, ) -> Self

Create a routing table with uniform distribution of vShards across data groups.

num_groups is the number of data Raft groups. vShards are distributed round-robin across groups 1..=num_groups. Group 0 is the metadata group and is always included in group_members but is never assigned any vShards — it is accessed only via propose_to_metadata_group, never via propose(vshard_id, data).

Each data group initially contains replication_factor nodes from nodes. The metadata group (0) receives the same membership as the first data group.

Source

pub fn group_for_vshard(&self, vshard_id: u32) -> Result<u64>

Look up which Raft group owns a vShard.

Source

pub fn leader_for_vshard(&self, vshard_id: u32) -> Result<u64>

Look up the leader node for a vShard.

Source

pub fn group_info(&self, group_id: u64) -> Option<&GroupInfo>

Get group info.

Source

pub fn set_leader(&mut self, group_id: u64, leader: u64)

Update the leader for a Raft group.

Source

pub fn reassign_vshard(&mut self, vshard_id: u32, new_group_id: u64)

Atomically reassign a vShard to a different Raft group. Used during Phase 3 (atomic cut-over) of shard migration.

Source

pub fn vshards_for_group(&self, group_id: u64) -> Vec<u32>

All vShards assigned to a given group.

Source

pub fn num_groups(&self) -> usize

Number of Raft groups.

Source

pub fn group_ids(&self) -> Vec<u64>

All group IDs.

Source

pub fn set_group_members(&mut self, group_id: u64, members: Vec<u64>)

Update the voting members of a Raft group (for membership changes).

Source

pub fn remove_group_member(&mut self, group_id: u64, node_id: u64) -> bool

Remove a node from a group’s voter and learner lists. If the removed node was the current leader hint, the hint is cleared so the next query drives a fresh discovery. Returns true if the group existed and anything was actually removed.

The caller is responsible for safety: dropping below the configured replication factor must be gated by decommission::safety::check_can_decommission.

Source

pub fn set_group_learners(&mut self, group_id: u64, learners: Vec<u64>)

Update the learner list for a Raft group.

Source

pub fn add_group_learner(&mut self, group_id: u64, peer: u64)

Add a learner to a group if not already present. No-op if the peer is already a voter or a learner.

Source

pub fn promote_group_learner(&mut self, group_id: u64, peer: u64) -> bool

Promote a learner to a voter within a group. Returns true if the learner was found and promoted.

Source

pub fn vshard_to_group(&self) -> &[u64]

Access the vshard-to-group mapping (for persistence / wire transfer).

Source

pub fn group_members(&self) -> &HashMap<u64, GroupInfo>

Access all group members (for persistence / wire transfer).

Source

pub fn from_parts( vshard_to_group: Vec<u64>, group_members: HashMap<u64, GroupInfo>, ) -> Self

Reconstruct a RoutingTable from persisted data.

Trait Implementations§

Source§

impl Clone for RoutingTable

Source§

fn clone(&self) -> RoutingTable

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RoutingTable

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for RoutingTable

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for RoutingTable

Source§

fn read<R: Read<'__msgpack_de>>(reader: &mut R) -> Result<Self, Error>
where Self: Sized,

Reads the MessagePack representation of this value from the provided reader.
Source§

impl Serialize for RoutingTable

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl ToMessagePack for RoutingTable

Source§

fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes the MessagePack representation of this value into the provided writer.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> FromMessagePackOwned for T
where T: for<'a> FromMessagePack<'a>,