Enum tikv_client::ColumnFamily

pub enum ColumnFamily {
    Default,
    Lock,
    Write,
}

A ColumnFamily is an optional parameter for raw::Client requests.

TiKV uses RocksDB’s ColumnFamily support. You can learn more about RocksDB’s ColumnFamilys on their wiki.

By default in TiKV data is stored in three different ColumnFamily values, configurable in the TiKV server’s configuration:

• Default: Where real user data is stored. Set by [rocksdb.defaultcf].
• Write: Where MVCC and index related data are stored. Set by [rocksdb.writecf].
• Lock: Where lock information is stored. Set by [rocksdb.lockcf].

Not providing a call a ColumnFamily means it will use the default value of default.

The best (and only) way to create a ColumnFamily is via the From implementation:

Examples

let cf = ColumnFamily::try_from("write").unwrap();
let cf = ColumnFamily::try_from(String::from("write")).unwrap();

But, you should not need to worry about all this: Many functions which accept a ColumnFamily accept an Into<ColumnFamily>, which means all of the above types can be passed directly to those functions.

Variants

Default

Lock

Write

Trait Implementations

impl Clone for ColumnFamily

fn clone(&self) -> ColumnFamily

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ColumnFamily

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

Formats the value using the given formatter.

impl Display for ColumnFamily

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

Formats the value using the given formatter.

impl Hash for ColumnFamily

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ColumnFamily

fn eq(&self, other: &ColumnFamily) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for ColumnFamily

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for ColumnFamily

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ColumnFamily

impl StructuralPartialEq for ColumnFamily