Struct FieldSchema 

pub struct FieldSchema { /* private fields */ }

Schema definition for a single field in a collection.

Implementations

impl FieldSchema

pub fn new( name: &str, data_type: DataType, nullable: bool, dimension: u32, ) -> Result<Self>

Creates a new field schema.

• name: Field name
• data_type: Data type of the field
• nullable: Whether the field can be null
• dimension: Vector dimension (0 for non-vector fields)

pub fn set_index_params(&mut self, params: &IndexParams) -> Result<()>

Sets the index parameters for this field.

pub fn name(&self) -> &str

Returns the field name.

pub fn data_type(&self) -> DataType

Returns the data type.

pub fn dimension(&self) -> u32

Returns the dimension (for vector fields).

pub fn is_nullable(&self) -> bool

Returns whether the field is nullable.

pub fn is_vector_field(&self) -> bool

Returns whether this is a vector field.

pub fn is_dense_vector(&self) -> bool

Returns whether this is a dense vector field.

pub fn is_sparse_vector(&self) -> bool

Returns whether this is a sparse vector field.

pub fn has_index(&self) -> bool

Returns whether this field has an index.

pub fn index_type(&self) -> IndexType

Returns the index type.

pub fn is_array_type(&self) -> bool

Returns whether this is an array type.

Trait Implementations

impl Drop for FieldSchema

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.