Struct CreateCollection

pub struct CreateCollection {

    pub collection_name: String,
    pub hnsw_config: Option<HnswConfigDiff>,
    pub wal_config: Option<WalConfigDiff>,
    pub optimizers_config: Option<OptimizersConfigDiff>,
    pub shard_number: Option<u32>,
    pub on_disk_payload: Option<bool>,
    pub timeout: Option<u64>,
    pub vectors_config: Option<VectorsConfig>,
    pub replication_factor: Option<u32>,
    pub write_consistency_factor: Option<u32>,
    pub init_from_collection: Option<String>,
    pub quantization_config: Option<QuantizationConfig>,
    pub sharding_method: Option<i32>,
    pub sparse_vectors_config: Option<SparseVectorConfig>,
    pub strict_mode_config: Option<StrictModeConfig>,
}

Fields

collection_name: String

Name of the collection

hnsw_config: Option<HnswConfigDiff>

Configuration of vector index

wal_config: Option<WalConfigDiff>

Configuration of the Write-Ahead-Log

optimizers_config: Option<OptimizersConfigDiff>

Configuration of the optimizers

shard_number: Option<u32>

Number of shards in the collection, default is 1 for standalone, otherwise equal to the number of nodes. Minimum is 1

on_disk_payload: Option<bool>

If true - point’s payload will not be stored in memory

timeout: Option<u64>

Wait timeout for operation commit in seconds, if not specified - default value will be supplied

vectors_config: Option<VectorsConfig>

Configuration for vectors

replication_factor: Option<u32>

Number of replicas of each shard that network tries to maintain, default = 1

write_consistency_factor: Option<u32>

How many replicas should apply the operation for us to consider it successful, default = 1

init_from_collection: Option<String>

Specify name of the other collection to copy data from

quantization_config: Option<QuantizationConfig>

Quantization configuration of vector

sharding_method: Option<i32>

Sharding method

sparse_vectors_config: Option<SparseVectorConfig>

Configuration for sparse vectors

strict_mode_config: Option<StrictModeConfig>

Configuration for strict mode

Implementations

impl CreateCollection

pub fn shard_number(&self) -> u32

Returns the value of shard_number, or the default value if shard_number is unset.

pub fn on_disk_payload(&self) -> bool

Returns the value of on_disk_payload, or the default value if on_disk_payload is unset.

pub fn timeout(&self) -> u64

Returns the value of timeout, or the default value if timeout is unset.

pub fn replication_factor(&self) -> u32

Returns the value of replication_factor, or the default value if replication_factor is unset.

pub fn write_consistency_factor(&self) -> u32

Returns the value of write_consistency_factor, or the default value if write_consistency_factor is unset.

pub fn init_from_collection(&self) -> &str

Returns the value of init_from_collection, or the default value if init_from_collection is unset.

pub fn sharding_method(&self) -> ShardingMethod

Returns the enum value of sharding_method, or the default if the field is unset or set to an invalid enum value.

pub fn set_sharding_method(&mut self, value: ShardingMethod)

Sets sharding_method to the provided enum value.

Trait Implementations

impl Clone for CreateCollection

fn clone(&self) -> CreateCollection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCollection

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

Formats the value using the given formatter.

impl Default for CreateCollection

fn default() -> Self

Returns the “default value” for a type.

impl From<CreateCollectionBuilder> for CreateCollection

fn from(value: CreateCollectionBuilder) -> Self

Converts to this type from the input type.

impl Message for CreateCollection

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CreateCollection

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