Struct ColumnSchema

pub struct ColumnSchema {
    pub name: String,
    pub data_type: ConcreteDataType,
    is_nullable: bool,
    is_time_index: bool,
    default_constraint: Option<ColumnDefaultConstraint>,
    metadata: HashMap<String, String>,
}

Schema of a column, used as an immutable struct.

Fields

name: String

data_type: ConcreteDataType

is_nullable: bool

is_time_index: bool

default_constraint: Option<ColumnDefaultConstraint>

metadata: HashMap<String, String>

Implementations

impl ColumnSchema

pub fn new<T>( name: T, data_type: ConcreteDataType, is_nullable: bool, ) -> ColumnSchema

where T: Into<String>,

pub fn is_time_index(&self) -> bool

pub fn is_nullable(&self) -> bool

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

pub fn metadata(&self) -> &HashMap<String, String>

pub fn mut_metadata(&mut self) -> &mut HashMap<String, String>

pub fn column_comment(&self) -> Option<&String>

Retrieve the column comment

pub fn with_time_index(self, is_time_index: bool) -> ColumnSchema

pub fn set_inverted_index(self, value: bool) -> ColumnSchema

pub fn is_inverted_indexed(&self) -> bool

pub fn has_inverted_index_key(&self) -> bool

pub fn with_default_constraint( self, default_constraint: Option<ColumnDefaultConstraint>, ) -> Result<ColumnSchema, Error>

Set default constraint.

If a default constraint exists for the column, this method will validate it against the column’s data type and nullability.

pub fn with_nullable_set(self) -> ColumnSchema

Set the nullablity to true of the column. Similar to set_nullable but take the ownership and return a owned value.

pub fn set_nullable(&mut self)

Set the nullability to true of the column. Similar to with_nullable_set but don’t take the ownership

pub fn set_time_index(&mut self)

Set the is_time_index to true of the column. Similar to with_time_index but don’t take the ownership.

pub fn with_metadata(self, metadata: HashMap<String, String>) -> ColumnSchema

Creates a new ColumnSchema with given metadata.

pub fn create_default_vector( &self, num_rows: usize, ) -> Result<Option<Arc<dyn Vector>>, Error>

Creates a vector with default value for this column.

If the column is NOT NULL but doesn’t has DEFAULT value supplied, returns Ok(None).

pub fn create_default_vector_for_padding( &self, num_rows: usize, ) -> Arc<dyn Vector>

Creates a vector for padding.

This method always returns a vector since it uses [DataType::default_value] to fill the vector. Callers should only use the created vector for padding and never read its content.

pub fn create_default(&self) -> Result<Option<Value>, Error>

Creates a default value for this column.

If the column is NOT NULL but doesn’t has DEFAULT value supplied, returns Ok(None).

pub fn fulltext_options(&self) -> Result<Option<FulltextOptions>, Error>

Retrieves the fulltext options for the column.

pub fn with_fulltext_options( self, options: FulltextOptions, ) -> Result<ColumnSchema, Error>

pub fn set_fulltext_options( &mut self, options: &FulltextOptions, ) -> Result<(), Error>

Trait Implementations

impl Clone for ColumnSchema

fn clone(&self) -> ColumnSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColumnSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ColumnSchema

fn eq(&self, other: &ColumnSchema) -> 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 ColumnSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Field> for ColumnSchema

type Error = Error

The type returned in the event of a conversion error.

fn try_from(field: &Field) -> Result<ColumnSchema, Error>

Performs the conversion.

impl Eq for ColumnSchema

impl StructuralPartialEq for ColumnSchema