Struct SchemaDefinition

#[non_exhaustive]
pub struct SchemaDefinition {
    pub all_columns: Vec<ColumnDefinition>,
    pub partition_keys: Vec<PartitionKey>,
    pub clustering_keys: Option<Vec<ClusteringKey>>,
    pub static_columns: Option<Vec<StaticColumn>>,
}

Describes the schema of the table.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

all_columns: Vec<ColumnDefinition>

The regular columns of the table.

partition_keys: Vec<PartitionKey>

The columns that are part of the partition key of the table .

clustering_keys: Option<Vec<ClusteringKey>>

The columns that are part of the clustering key of the table.

static_columns: Option<Vec<StaticColumn>>

The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.

Implementations

impl SchemaDefinition

pub fn all_columns(&self) -> &[ColumnDefinition]

The regular columns of the table.

pub fn partition_keys(&self) -> &[PartitionKey]

The columns that are part of the partition key of the table .

pub fn clustering_keys(&self) -> &[ClusteringKey]

The columns that are part of the clustering key of the table.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .clustering_keys.is_none().

pub fn static_columns(&self) -> &[StaticColumn]

The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .static_columns.is_none().

impl SchemaDefinition

pub fn builder() -> SchemaDefinitionBuilder

Creates a new builder-style object to manufacture SchemaDefinition.

Trait Implementations

impl Clone for SchemaDefinition

fn clone(&self) -> SchemaDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaDefinition

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

Formats the value using the given formatter.

impl PartialEq for SchemaDefinition

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SchemaDefinition