Struct StorageTableDesc

pub struct StorageTableDesc {
    pub table_id: u32,
    pub columns: Vec<ColumnDesc>,
    pub pk: Vec<ColumnOrder>,
    pub dist_key_in_pk_indices: Vec<u32>,
    pub value_indices: Vec<u32>,
    pub read_prefix_len_hint: u32,
    pub versioned: bool,
    pub stream_key: Vec<u32>,
    pub vnode_col_idx_in_pk: Option<u32>,
    pub retention_seconds: Option<u32>,
    pub maybe_vnode_count: Option<u32>,
}

Fields

table_id: u32

columns: Vec<ColumnDesc>

pk: Vec<ColumnOrder>

TODO: may refactor primary key representations

dist_key_in_pk_indices: Vec<u32>

value_indices: Vec<u32>

read_prefix_len_hint: u32

versioned: bool

Whether the table is versioned. If true, column-aware row encoding will be used to be compatible with schema changes.

stream_key: Vec<u32>

vnode_col_idx_in_pk: Option<u32>

retention_seconds: Option<u32>

maybe_vnode_count: Option<u32>

Total vnode count of the table.

Can be unset if the table is created in older versions where variable vnode count is not supported, in which case a default value of 256 (or 1 for singleton) should be used. Use VnodeCountCompat::vnode_count to access it.

Implementations

impl StorageTableDesc

pub fn vnode_col_idx_in_pk(&self) -> u32

Returns the value of vnode_col_idx_in_pk, or the default value if vnode_col_idx_in_pk is unset.

pub fn retention_seconds(&self) -> u32

Returns the value of retention_seconds, or the default value if retention_seconds is unset.

pub fn maybe_vnode_count(&self) -> u32

Returns the value of maybe_vnode_count, or the default value if maybe_vnode_count is unset.

impl StorageTableDesc

pub fn get_table_id(&self) -> u32

pub fn get_columns(&self) -> &Vec<ColumnDesc>

pub fn get_pk(&self) -> &Vec<ColumnOrder>

pub fn get_dist_key_in_pk_indices(&self) -> &Vec<u32>

pub fn get_value_indices(&self) -> &Vec<u32>

pub fn get_read_prefix_len_hint(&self) -> u32

pub fn get_versioned(&self) -> bool

pub fn get_stream_key(&self) -> &Vec<u32>

pub fn get_vnode_col_idx_in_pk(&self) -> Result<&u32, PbFieldNotFound>

pub fn get_retention_seconds(&self) -> Result<&u32, PbFieldNotFound>

pub fn get_maybe_vnode_count(&self) -> Result<&u32, PbFieldNotFound>

Trait Implementations

impl Clone for StorageTableDesc

fn clone(&self) -> StorageTableDesc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageTableDesc

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

Formats the value using the given formatter.

impl Default for StorageTableDesc

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StorageTableDesc

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for StorageTableDesc

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for StorageTableDesc

fn eq(&self, other: &StorageTableDesc) -> 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 Serialize for StorageTableDesc

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StorageTableDesc