Struct ColumnDescriptor

pub struct ColumnDescriptor {
    pub id: ColumnId,
    pub name: String,
    pub data_type: ConcreteDataType,
    is_nullable: bool,
    is_time_index: bool,
    default_constraint: Option<ColumnDefaultConstraint>,
    pub comment: String,
}

A ColumnDescriptor contains information to create a column.

Fields

id: ColumnId

name: String

data_type: ConcreteDataType

is_nullable: bool

Is column nullable, default is true.

is_time_index: bool

Is time index column, default is true.

default_constraint: Option<ColumnDefaultConstraint>

Default constraint of column, default is None, which means no default constraint for this column, and user must provide a value for a not-null column.

comment: String

Implementations

impl ColumnDescriptor

pub fn is_nullable(&self) -> bool

pub fn is_time_index(&self) -> bool

pub fn default_constraint(&self) -> Option<&ColumnDefaultConstraint>

pub fn to_column_schema(&self) -> ColumnSchema

Convert ColumnDescriptor to ColumnSchema. Fields not in ColumnSchema will not be stored as metadata.

Trait Implementations

impl Clone for ColumnDescriptor

fn clone(&self) -> ColumnDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColumnDescriptor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ColumnDescriptor

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

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

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 Serialize for ColumnDescriptor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ColumnDescriptor

impl StructuralPartialEq for ColumnDescriptor