Struct PartitionTree

pub struct PartitionTree {
    config: PartitionTreeConfig,
    pub(crate) metadata: RegionMetadataRef,
    row_codec: Arc<dyn PrimaryKeyCodec>,
    partitions: RwLock<BTreeMap<u32, Arc<Partition>>>,
    is_partitioned: bool,
    write_buffer_manager: Option<WriteBufferManagerRef>,
    sparse_encoder: Arc<SparseEncoder>,
}

The partition tree.

Fields

config: PartitionTreeConfig

Config of the tree.

metadata: RegionMetadataRef

Metadata of the region.

row_codec: Arc<dyn PrimaryKeyCodec>

Primary key codec.

partitions: RwLock<BTreeMap<u32, Arc<Partition>>>

Partitions in the tree.

is_partitioned: bool

Whether the tree has multiple partitions.

write_buffer_manager: Option<WriteBufferManagerRef>

Manager to report size of the tree.

sparse_encoder: Arc<SparseEncoder>

Implementations

impl PartitionTree

pub fn new( row_codec: Arc<dyn PrimaryKeyCodec>, metadata: RegionMetadataRef, config: &PartitionTreeConfig, write_buffer_manager: Option<WriteBufferManagerRef>, ) -> Self

Creates a new partition tree.

fn verify_primary_key_length(&self, kv: &KeyValue<'_>) -> Result<()>

fn encode_sparse_primary_key( &self, kv: &KeyValue<'_>, buffer: &mut Vec<u8>, ) -> Result<()>

Encodes the given key value into a sparse primary key.

pub fn write( &self, kvs: &KeyValues, pk_buffer: &mut Vec<u8>, metrics: &mut WriteMetrics, ) -> Result<()>

Write key-values into the tree.

Panics

Panics if the tree is immutable (frozen).

pub fn write_one( &self, kv: KeyValue<'_>, pk_buffer: &mut Vec<u8>, metrics: &mut WriteMetrics, ) -> Result<()>

Write one key value pair into the tree.

Panics

Panics if the tree is immutable (frozen).

pub fn read( &self, projection: Option<&[ColumnId]>, predicate: Option<Predicate>, sequence: Option<SequenceNumber>, ) -> Result<BoxedBatchIterator>

Scans the tree.

pub fn is_empty(&self) -> bool

Returns true if the tree is empty.

A tree is empty if no partition has data.

pub fn freeze(&self) -> Result<()>

Marks the tree as immutable.

Once the tree becomes immutable, callers should not write to it again.

pub fn fork(&self, metadata: RegionMetadataRef) -> PartitionTree

Forks an immutable tree. Returns a mutable tree that inherits the index of this tree.

pub(crate) fn write_buffer_manager(&self) -> Option<WriteBufferManagerRef>

Returns the write buffer manager.

fn write_with_key( &self, primary_key: &mut Vec<u8>, key_value: KeyValue<'_>, metrics: &mut WriteMetrics, ) -> Result<()>

fn write_no_key(&self, key_value: KeyValue<'_>) -> Result<()>

fn get_or_create_partition(&self, partition_key: u32) -> Arc<Partition>

fn prune_partitions( &self, filters: &[SimpleFilterEvaluator], metrics: &mut TreeIterMetrics, ) -> VecDeque<Arc<Partition>>