Skip to main content

SstFileWriter

Struct SstFileWriter 

Source
pub struct SstFileWriter { /* private fields */ }
Expand description

Writes a standalone SSTable file that a running crate::Db can bulk-ingest via crate::Db::ingest_external_files.

Keys must be supplied in strictly ascending user-key order - duplicates and out-of-order keys are rejected with an error. Every entry is written with a placeholder sequence number of 0; the real sequence number is assigned by the engine when the file is ingested.

Implementations§

Source§

impl SstFileWriter

Source

pub fn create<P: AsRef<Path>>(path: P, opts: &Options) -> Result<Self>

Create a new SSTable file at path. The file is overwritten if it already exists. The writer borrows block_size, bloom_bits_per_key, and compression from opts after validating the option invariants.

Source

pub fn put(&mut self, key: &[u8], value: &[u8]) -> Result<()>

Append a (key, value) pair to the default column family. key must be strictly greater than every previously added key.

Source

pub fn delete(&mut self, key: &[u8]) -> Result<()>

Append a deletion tombstone for key in the default column family.

Source

pub fn put_cf( &mut self, cf: &ColumnFamilyHandle, key: &[u8], value: &[u8], ) -> Result<()>

Append a (key, value) pair scoped to column family cf. Keys across CFs must still arrive in strictly ascending order (by prefixed bytes).

Source

pub fn delete_cf(&mut self, cf: &ColumnFamilyHandle, key: &[u8]) -> Result<()>

Append a deletion tombstone scoped to column family cf.

Source

pub fn finish(self) -> Result<SstFileMeta>

Finalize the file. Errors if no entries were written - an empty ingest file is almost certainly a bug and would be rejected at ingest time anyway.

Auto Trait Implementations§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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.
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