Struct CollectionSchema 

pub struct CollectionSchema { /* private fields */ }

Schema definition for a collection, containing field definitions.

Implementations

impl CollectionSchema

pub fn new(name: &str) -> Result<Self>

Creates a new collection schema with the given name.

pub fn builder(name: &str) -> CollectionSchemaBuilder

Returns a builder for constructing a collection schema.

pub fn add_field(&mut self, field: &FieldSchema) -> Result<()>

Adds a field to the schema.

pub fn name(&self) -> &str

Returns the collection name.

pub fn has_field(&self, name: &str) -> bool

Checks if a field exists in the schema.

pub fn has_index(&self, field_name: &str) -> bool

Checks if a field has an index.

pub fn drop_field(&mut self, name: &str) -> Result<()>

Drops a field from the schema.

pub fn add_index( &mut self, field_name: &str, params: &IndexParams, ) -> Result<()>

Adds an index to a field.

pub fn drop_index(&mut self, field_name: &str) -> Result<()>

Drops an index from a field.

pub fn set_max_doc_count_per_segment(&mut self, count: u64) -> Result<()>

Sets the maximum document count per segment.

pub fn max_doc_count_per_segment(&self) -> u64

Returns the maximum document count per segment.

Trait Implementations

impl Drop for CollectionSchema

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.