Skip to main content

CollectionType

Enum CollectionType 

Source
pub enum CollectionType {
    Document(DocumentMode),
    Columnar(ColumnarProfile),
    KeyValue(KvConfig),
}
Expand description

The type of a collection, determining its storage engine and query behavior.

Three top-level modes:

  • Document: B-tree storage in redb (schemaless MessagePack or strict Binary Tuples).
  • Columnar: Compressed segment files with profile specialization (plain, timeseries, spatial).
  • KeyValue: Hash-indexed O(1) point lookups with typed value fields (Binary Tuples).

Variants§

§

Document(DocumentMode)

Document storage in redb B-tree. Schemaless (MessagePack) or strict (Binary Tuples).

§

Columnar(ColumnarProfile)

Columnar storage in compressed segment files. Profile determines constraints and specialized behavior.

§

KeyValue(KvConfig)

Key-Value storage with hash-indexed primary key. O(1) point lookups, optional TTL, optional secondary indexes. Value fields use Binary Tuple codec (same as strict mode) for O(1) field extraction.

Implementations§

Source§

impl CollectionType

Source

pub fn document() -> Self

Schemaless document (default, backward compatible).

Source

pub fn strict(schema: StrictSchema) -> Self

Strict document with schema.

Source

pub fn columnar() -> Self

Plain columnar (general analytics).

Source

pub fn timeseries( time_key: impl Into<String>, interval: impl Into<String>, ) -> Self

Columnar with timeseries profile.

Source

pub fn spatial(geometry_column: impl Into<String>) -> Self

Columnar with spatial profile.

Source

pub fn kv(schema: StrictSchema) -> Self

Key-Value collection with typed schema and optional TTL.

The schema MUST contain exactly one PRIMARY KEY column (the hash key). Remaining columns are value fields encoded as Binary Tuples.

Source

pub fn kv_with_ttl(schema: StrictSchema, ttl: KvTtlPolicy) -> Self

Key-Value collection with TTL policy.

Source

pub fn is_document(&self) -> bool

Source

pub fn is_columnar_family(&self) -> bool

Returns true for any columnar-family type (Plain, Timeseries, Spatial). Use is_plain_columnar() to check for plain columnar only.

Source

pub fn is_plain_columnar(&self) -> bool

Source

pub fn is_timeseries(&self) -> bool

Source

pub fn is_spatial(&self) -> bool

Source

pub fn is_strict(&self) -> bool

Source

pub fn is_schemaless(&self) -> bool

Source

pub fn is_kv(&self) -> bool

Source

pub fn as_str(&self) -> &'static str

Source

pub fn document_mode(&self) -> Option<&DocumentMode>

Get the document mode, if this is a document collection.

Source

pub fn columnar_profile(&self) -> Option<&ColumnarProfile>

Get the columnar profile, if this is a columnar collection.

Source

pub fn kv_config(&self) -> Option<&KvConfig>

Get the KV config, if this is a key-value collection.

Trait Implementations§

Source§

impl Clone for CollectionType

Source§

fn clone(&self) -> CollectionType

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CollectionType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CollectionType

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CollectionType

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for CollectionType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for CollectionType

Source§

fn read<R: Read<'__msgpack_de>>(reader: &mut R) -> Result<Self, Error>
where Self: Sized,

Reads the MessagePack representation of this value from the provided reader.
Source§

impl FromStr for CollectionType

Source§

type Err = String

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for CollectionType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for CollectionType

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl ToMessagePack for CollectionType

Source§

fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes the MessagePack representation of this value into the provided writer.
Source§

impl Eq for CollectionType

Source§

impl StructuralPartialEq for CollectionType

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> FromMessagePackOwned for T
where T: for<'a> FromMessagePack<'a>,