Struct FieldSchemaBuilder

pub struct FieldSchemaBuilder { /* private fields */ }

Builder for FieldSchema.

Implementations

impl FieldSchemaBuilder

pub fn field_name<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

must start with a letter, only lowercase and uppercase letters, numbers and underscores are allowed

pub fn field_type<VALUE: Into<FieldType>>(&mut self, value: VALUE) -> &mut Self

BOOL、INT8、UINT8、INT16、UINT16、INT32、UINT32、INT64、UINT64、FLOAT、DOUBLE、DATE、DATETIME、TIMESTAMP、UUID、STRING、BINARY、TEXT、TEXT_GBK、TEXT_GB18030、FLOAT_VECTOR

pub fn primary_key<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

only a single field is supported for primary key currently, unsupport field with type: BOOL、FLOAT、DOUBLE、FLOAT_VECTOR

pub fn partition_key<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

only a single field is supported as a partition key, which can be a primary key or not, a table can only have one partition key, each record will be hashed and mapped to diffrent partition, unsupport field with type: BOOL、FLOAT、DOUBLE、FLOAT_VECTOR

pub fn auto_increment<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

is autoincreament, only applicable to primary key fields of type UINT64

pub fn not_null<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

primary key field, partition key field, secondary index key field and vector field cannot be nullable

pub fn dimension<VALUE: Into<Option<u32>>>(&mut self, value: VALUE) -> &mut Self

vector dimension. This parameter needs to be specified only when the data type is FLOAT_VECTOR.

pub fn build(&self) -> Result<FieldSchema, FieldSchemaBuilderError>

Builds a new FieldSchema.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for FieldSchemaBuilder

fn clone(&self) -> FieldSchemaBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for FieldSchemaBuilder

fn default() -> Self

Returns the “default value” for a type.