risingwave_storage::hummock::sstable::builder

Struct SstableBuilder

source
pub struct SstableBuilder<W: SstableWriter, F: FilterBuilder> {
Show 17 fields options: SstableBuilderOptions, writer: W, block_builder: BlockBuilder, compaction_catalog_agent_ref: CompactionCatalogAgentRef, block_metas: Vec<BlockMeta>, table_ids: BTreeSet<u32>, last_full_key: Vec<u8>, raw_key: BytesMut, raw_value: BytesMut, last_table_id: Option<u32>, sstable_id: u64, table_stats: TableStatsMap, last_table_stats: TableStats, filter_builder: F, epoch_set: BTreeSet<u64>, memory_limiter: Option<Arc<MemoryLimiter>>, block_size_vec: Vec<usize>,
}

Fields§

§options: SstableBuilderOptions

Options.

§writer: W

Data writer.

§block_builder: BlockBuilder

Current block builder.

§compaction_catalog_agent_ref: CompactionCatalogAgentRef§block_metas: Vec<BlockMeta>

Block metadata vec.

§table_ids: BTreeSet<u32>

table_id of added keys.

§last_full_key: Vec<u8>§raw_key: BytesMut

Buffer for encoded key and value to avoid allocation.

§raw_value: BytesMut§last_table_id: Option<u32>§sstable_id: u64§table_stats: TableStatsMap

Per table stats.

§last_table_stats: TableStats

last_table_stats accumulates stats for last_table_id and finalizes it in table_stats by finalize_last_table_stats

§filter_builder: F§epoch_set: BTreeSet<u64>§memory_limiter: Option<Arc<MemoryLimiter>>§block_size_vec: Vec<usize>

Implementations§

source§

impl<W: SstableWriter> SstableBuilder<W, Xor16FilterBuilder>

source

pub fn for_test( sstable_id: u64, writer: W, options: SstableBuilderOptions, table_id_to_vnode: HashMap<StateTableId, usize>, ) -> Self

source§

impl<W: SstableWriter, F: FilterBuilder> SstableBuilder<W, F>

source

pub fn new( sstable_id: u64, writer: W, filter_builder: F, options: SstableBuilderOptions, compaction_catalog_agent_ref: CompactionCatalogAgentRef, memory_limiter: Option<Arc<MemoryLimiter>>, ) -> Self

source

pub async fn add_for_test( &mut self, full_key: FullKey<&[u8]>, value: HummockValue<&[u8]>, ) -> HummockResult<()>

Add kv pair to sstable.

source

pub fn current_block_size(&self) -> usize

source

pub async fn add_raw_block( &mut self, buf: Bytes, filter_data: Vec<u8>, smallest_key: FullKey<Vec<u8>>, largest_key: Vec<u8>, meta: BlockMeta, ) -> HummockResult<bool>

Add raw data of block to sstable. return false means fallback

source

pub async fn add( &mut self, full_key: FullKey<&[u8]>, value: HummockValue<&[u8]>, ) -> HummockResult<()>

Add kv pair to sstable.

source

async fn add_impl( &mut self, full_key: FullKey<&[u8]>, value: HummockValue<&[u8]>, could_switch_block: bool, ) -> HummockResult<()>

Add kv pair to sstable.

source

pub async fn finish(self) -> HummockResult<SstableBuilderOutput<W::Output>>

Finish building sst.

§Format

data:

| Block 0 | ... | Block N-1 | N (4B) |
source

pub fn approximate_len(&self) -> usize

source

pub async fn build_block(&mut self) -> HummockResult<()>

source

pub fn is_empty(&self) -> bool

source

pub fn reach_capacity(&self) -> bool

Returns true if we roughly reached capacity

source

fn finalize_last_table_stats(&mut self)

Auto Trait Implementations§

§

impl<W, F> Freeze for SstableBuilder<W, F>
where W: Freeze, F: Freeze,

§

impl<W, F> !RefUnwindSafe for SstableBuilder<W, F>

§

impl<W, F> Send for SstableBuilder<W, F>

§

impl<W, F> Sync for SstableBuilder<W, F>
where W: Sync, F: Sync,

§

impl<W, F> Unpin for SstableBuilder<W, F>
where W: Unpin, F: Unpin,

§

impl<W, F> !UnwindSafe for SstableBuilder<W, F>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> IntoResult<T> for T

§

type Err = Infallible

§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<M> MetricVecRelabelExt for M

source§

fn relabel( self, metric_level: MetricLevel, relabel_threshold: MetricLevel, ) -> RelabeledMetricVec<M>

source§

fn relabel_n( self, metric_level: MetricLevel, relabel_threshold: MetricLevel, relabel_num: usize, ) -> RelabeledMetricVec<M>

source§

fn relabel_debug_1( self, relabel_threshold: MetricLevel, ) -> RelabeledMetricVec<M>

Equivalent to RelabeledMetricVec::with_metric_level_relabel_n with metric_level set to MetricLevel::Debug and relabel_num set to 1.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> LruValue for T
where T: Send + Sync,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> Value for T
where T: Send + Sync + 'static,