Struct rocks::db::ColumnFamily

pub struct ColumnFamily { /* fields omitted */ }

An opened column family, owned for RAII style management

Implementations

impl ColumnFamily

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

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

pub fn single_delete(&self, options: &WriteOptions, key: &[u8]) -> Result<()>

pub fn delete_range(
    &self,
    options: &WriteOptions,
    begin_key: &[u8],
    end_key: &[u8]
) -> Result<()>

pub fn merge(
    &self,
    options: &WriteOptions,
    key: &[u8],
    val: &[u8]
) -> Result<()>

pub fn get(&self, options: &ReadOptions, key: &[u8]) -> Result<PinnableSlice>

pub fn multi_get(
    &self,
    options: &ReadOptions,
    keys: &[&[u8]]
) -> Vec<Result<PinnableSlice>>

pub fn key_may_exist(&self, options: &ReadOptions, key: &[u8]) -> bool

If the key definitely does not exist in the database, then this method returns false, else true. If the caller wants to obtain value when the key is found in memory, a bool for 'value_found' must be passed. 'value_found' will be true on return if value has been set properly.

This check is potentially lighter-weight than invoking DB::Get(). One way to make this lighter weight is to avoid doing any IOs.

pub fn key_may_get(
    &self,
    options: &ReadOptions,
    key: &[u8]
) -> (bool, Option<Vec<u8>>)

pub fn new_iterator(&self, options: &ReadOptions) -> Iteratorⓘ

Important traits for Iterator<'a>

impl<'a> Iterator for Iterator<'a> type Item = (&'a [u8], &'a [u8]);

pub fn get_property(&self, property: &str) -> Option<String>

pub fn get_int_property(&self, property: &str) -> Option<u64>

pub fn compact_range<R: AsCompactRange>(
    &self,
    options: &CompactRangeOptions,
    range: R
) -> Result<()>

pub fn set_options<T, H>(&self, new_options: H) -> Result<()> where
    T: AsRef<str>,
    H: IntoIterator<Item = (T, T)>, 

pub fn get_approximate_sizes(&self, ranges: &[Range<&[u8]>]) -> Vec<u64>

pub fn get_approximate_memtable_stats(&self, range: Range<&[u8]>) -> (u64, u64)

pub fn ingest_external_file<P: AsRef<Path>, T: IntoIterator<Item = P>>(
    &self,
    external_files: T,
    options: &IngestExternalFileOptions
) -> Result<()>

pub fn metadata(&self) -> ColumnFamilyMetaData

Obtains the meta data of the current column family of the DB.

Methods from Deref<Target = ColumnFamilyHandle>

pub fn name(&self) -> &str

Returns the name of the column family associated with the current handle.

pub fn id(&self) -> u32

Returns the ID of the column family associated with the current handle.

Trait Implementations

impl AsRef<ColumnFamilyHandle> for ColumnFamily

fn as_ref(&self) -> &ColumnFamilyHandle

Performs the conversion.

impl Debug for ColumnFamily

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Deref for ColumnFamily

type Target = ColumnFamilyHandle

The resulting type after dereferencing.

fn deref(&self) -> &ColumnFamilyHandle

Dereferences the value.

impl Drop for ColumnFamily

fn drop(&mut self)

Executes the destructor for this type.

impl Send for ColumnFamily

impl Sync for ColumnFamily