Struct SparsePrimaryKeyCodec

pub struct SparsePrimaryKeyCodec {
    inner: Arc<SparsePrimaryKeyCodecInner>,
}

A codec for sparse key of metrics. It requires the input primary key columns are sorted by the column name in lexicographical order. It encodes the column id of the physical region.

Fields

inner: Arc<SparsePrimaryKeyCodecInner>

Implementations

impl SparsePrimaryKeyCodec

pub fn from_columns(columns_ids: impl Iterator<Item = ColumnId>) -> Self

Creates a new SparsePrimaryKeyCodec instance.

pub fn new(region_metadata: &RegionMetadataRef) -> Self

Creates a new SparsePrimaryKeyCodec instance.

pub fn schemaless() -> Self

Returns a new SparsePrimaryKeyCodec instance.

It treats all unknown columns as primary key(label field).

pub fn with_fields(fields: Vec<(ColumnId, SortField)>) -> Self

Creates a new SparsePrimaryKeyCodec instance with additional label fields.

fn get_field(&self, column_id: ColumnId) -> Option<&SortField>

Returns the field of the given column id.

pub fn encode_to_vec<'a, I>(&self, row: I, buffer: &mut Vec<u8>) -> Result<()>

where I: Iterator<Item = (ColumnId, ValueRef<'a>)>,

Encodes the given bytes into a SparseValues.

pub fn encode_raw_tag_value<'a, I>( &self, row: I, buffer: &mut Vec<u8>, ) -> Result<()>

where I: Iterator<Item = (ColumnId, &'a [u8])>,

pub fn encode_internal( &self, table_id: u32, tsid: u64, buffer: &mut Vec<u8>, ) -> Result<()>

Encodes the given bytes into a SparseValues.

fn decode_sparse(&self, bytes: &[u8]) -> Result<SparseValues>

Decodes the given bytes into a SparseValues.

fn decode_leftmost(&self, bytes: &[u8]) -> Result<Option<Value>>

Decodes the given bytes into a Value.

pub fn has_column( &self, pk: &[u8], offsets_map: &mut HashMap<u32, usize>, column_id: ColumnId, ) -> Option<usize>

Returns the offset of the given column id in the given primary key.

pub fn decode_value_at( &self, pk: &[u8], offset: usize, column_id: ColumnId, ) -> Result<Value>

Decode value at offset in pk.

Trait Implementations

impl Clone for SparsePrimaryKeyCodec

fn clone(&self) -> SparsePrimaryKeyCodec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SparsePrimaryKeyCodec

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

Formats the value using the given formatter.

impl PrimaryKeyCodec for SparsePrimaryKeyCodec

fn encode_key_value( &self, _key_value: &KeyValue<'_>, _buffer: &mut Vec<u8>, ) -> Result<()>

Encodes a key value to bytes.

fn encode_values( &self, values: &[(ColumnId, Value)], buffer: &mut Vec<u8>, ) -> Result<()>

Encodes values to bytes.

fn encode_value_refs( &self, values: &[(ColumnId, ValueRef<'_>)], buffer: &mut Vec<u8>, ) -> Result<()>

Encodes values to bytes.

fn estimated_size(&self) -> Option<usize>

Returns the estimated size of the primary key.

fn num_fields(&self) -> Option<usize>

Returns the number of fields in the primary key.

fn encoding(&self) -> PrimaryKeyEncoding

Returns the encoding type of the primary key.

fn primary_key_filter( &self, metadata: &RegionMetadataRef, filters: Arc<Vec<SimpleFilterEvaluator>>, ) -> Box<dyn PrimaryKeyFilter>

Returns a primary key filter factory.

fn decode(&self, bytes: &[u8]) -> Result<CompositeValues>

Decodes the primary key from the given bytes.

fn decode_leftmost(&self, bytes: &[u8]) -> Result<Option<Value>>

Decode the leftmost value from bytes.