Struct ShardBuilder

pub struct ShardBuilder {
    current_shard_id: u32,
    dict_builder: KeyDictBuilder,
    data_buffer: DataBuffer,
    data_freeze_threshold: usize,
    dedup: bool,
}

Builder to write keys and data to a shard that the key dictionary is still active.

Fields

current_shard_id: u32

Id of the current shard to build.

dict_builder: KeyDictBuilder

Builder for the key dictionary.

data_buffer: DataBuffer

Buffer to store data.

data_freeze_threshold: usize

Number of rows to freeze a data part.

dedup: bool

Implementations

impl ShardBuilder

pub fn new( metadata: RegionMetadataRef, config: &PartitionTreeConfig, shard_id: u32, ) -> ShardBuilder

Returns a new builder.

pub fn write_with_pk_id(&mut self, pk_id: PkId, key_value: &KeyValue<'_>)

Write a key value with given pk_index (caller must ensure the pk_index exist in dict_builder)

pub fn write_with_key( &mut self, full_primary_key: &[u8], sparse_key: Option<&[u8]>, key_value: &KeyValue<'_>, metrics: &mut WriteMetrics, ) -> PkId

Write a key value with its encoded primary key.

pub fn should_freeze(&self) -> bool

Returns true if the builder need to freeze.

pub fn current_shard_id(&self) -> u32

Returns the current shard id of the builder.

pub fn finish( &mut self, metadata: RegionMetadataRef, pk_to_pk_id: &mut HashMap<Vec<u8>, PkId>, ) -> Result<Option<Shard>>

Builds a new shard and resets the builder.

Returns None if the builder is empty.

pub fn read( &self, pk_weights_buffer: &mut Vec<u16>, ) -> Result<ShardBuilderReaderBuilder>

Scans the shard builder.

pub fn is_empty(&self) -> bool

Returns true if the builder is empty.