Struct JoinEntryState 

pub struct JoinEntryState<E: JoinEncoding> {
    cached: JoinRowSet<Vec<u8>, E::EncodedRow>,
    inequality_index: JoinRowSet<Vec<u8>, JoinRowSet<Vec<u8>, ()>>,
    kv_heap_size: KvSize,
}

We manages a HashMap in memory for all entries belonging to a join key. When evicted, cached does not hold any entries.

If a JoinEntryState exists for a join key, the all records under this join key will be presented in the cache.

Fields

cached: JoinRowSet<Vec<u8>, E::EncodedRow>

The full copy of the state.

inequality_index: JoinRowSet<Vec<u8>, JoinRowSet<Vec<u8>, ()>>

Index used for AS OF join. The key is inequal column value. The value is the primary key in cached.

kv_heap_size: KvSize

Implementations

impl<E: JoinEncoding> JoinEntryState<E>

pub fn insert( &mut self, key: Vec<u8>, value: E::EncodedRow, inequality_key: Option<Vec<u8>>, ) -> Result<&mut E::EncodedRow, JoinEntryError>

Insert into the cache.

pub fn remove( &mut self, pk: Vec<u8>, inequality_key: Option<&Vec<u8>>, ) -> Result<(), JoinEntryError>

Delete from the cache.

fn remove_pk_from_inequality_index( &mut self, pk: &Vec<u8>, inequality_key: &Vec<u8>, )

fn insert_pk_to_inequality_index( &mut self, pk: Vec<u8>, inequality_key: Vec<u8>, )

pub fn get( &self, pk: &Vec<u8>, data_types: &[DataType], ) -> Option<StreamExecutorResult<JoinRow<E::DecodedRow>>>

pub fn values_mut<'a>( &'a mut self, data_types: &'a [DataType], ) -> impl Iterator<Item = (&'a mut E::EncodedRow, StreamExecutorResult<JoinRow<E::DecodedRow>>)> + 'a

Note: the first item in the tuple is the mutable reference to the value in this entry, while the second item is the decoded value. To mutate the degree, one must not forget to apply the changes to the first item.

WARNING: Should not change the heap size of StateValueType with the mutable reference.

pub fn len(&self) -> usize

pub fn range_by_inequality<'a, R>( &'a self, range: R, data_types: &'a [DataType], ) -> impl Iterator<Item = StreamExecutorResult<JoinRow<E::DecodedRow>>> + 'a

where R: RangeBounds<Vec<u8>> + 'a,

Range scan the cache using the inequality index.

pub fn upper_bound_by_inequality<'a>( &'a self, bound: Bound<&Vec<u8>>, data_types: &'a [DataType], ) -> Option<StreamExecutorResult<JoinRow<E::DecodedRow>>>

Get the records whose inequality key upper bound satisfy the given bound.

pub fn get_by_indexed_pk( &self, pk: &Vec<u8>, data_types: &[DataType], ) -> Option<StreamExecutorResult<JoinRow<E::DecodedRow>>>

pub fn lower_bound_by_inequality<'a>( &'a self, bound: Bound<&Vec<u8>>, data_types: &'a [DataType], ) -> Option<StreamExecutorResult<JoinRow<E::DecodedRow>>>

Get the records whose inequality key lower bound satisfy the given bound.

pub fn get_first_by_inequality<'a>( &'a self, inequality_key: &Vec<u8>, data_types: &'a [DataType], ) -> Option<StreamExecutorResult<JoinRow<E::DecodedRow>>>

pub fn inequality_index(&self) -> &JoinRowSet<Vec<u8>, JoinRowSet<Vec<u8>, ()>>

Trait Implementations

impl<E: Default + JoinEncoding> Default for JoinEntryState<E>

where E::EncodedRow: Default,

fn default() -> JoinEntryState<E>

Returns the “default value” for a type.

impl<E: JoinEncoding> EstimateSize for Box<JoinEntryState<E>>

fn estimated_heap_size(&self) -> usize

The estimated heap size of the current struct in bytes.

fn estimated_size(&self) -> usize

where Self: Sized,

The estimated total size of the current struct in bytes, including the estimated_heap_size and the size of Self.

impl<E: JoinEncoding> EstimateSize for JoinEntryState<E>

fn estimated_heap_size(&self) -> usize

The estimated heap size of the current struct in bytes.

fn estimated_size(&self) -> usize

where Self: Sized,

The estimated total size of the current struct in bytes, including the estimated_heap_size and the size of Self.