io.milvus.param.collection

类 CreateCollectionParam.Builder

java.lang.Object

io.milvus.param.collection.CreateCollectionParam.Builder

封闭类:

CreateCollectionParam

public static final class CreateCollectionParam.Builder
extends Object

Builder for CreateCollectionParam class.

方法概要

限定符和类型	方法和说明
CreateCollectionParam.Builder	addFieldType(@NonNull FieldType fieldType) Adds a field schema.
CreateCollectionParam	build() Verifies parameters and creates a new CreateCollectionParam instance.
CreateCollectionParam.Builder	withCollectionName(@NonNull String collectionName) Sets the collection name.
CreateCollectionParam.Builder	withDescription(@NonNull String description) Sets the collection description.
CreateCollectionParam.Builder	withFieldTypes(@NonNull List<FieldType> fieldTypes) Sets the schema of the collection.
CreateCollectionParam.Builder	withShardsNum(int shardsNum) Sets the shards number.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

withCollectionName

public CreateCollectionParam.Builder withCollectionName(@NonNull
                                                        @NonNull String collectionName)

Sets the collection name. Collection name cannot be empty or null.

参数:

collectionName - collection name

返回:

Builder

withShardsNum

public CreateCollectionParam.Builder withShardsNum(int shardsNum)

Sets the shards number. The number must be greater than zero. The default value is 2.

参数:

shardsNum - shards number to distribute insert data into multiple data nodes and query nodes.

返回:

Builder

withDescription

public CreateCollectionParam.Builder withDescription(@NonNull
                                                     @NonNull String description)

Sets the collection description. The description can be empty. The default is "".

参数:

description - description of the collection

返回:

Builder

withFieldTypes

public CreateCollectionParam.Builder withFieldTypes(@NonNull
                                                    @NonNull List<FieldType> fieldTypes)

Sets the schema of the collection. The schema cannot be empty or null.

参数:

fieldTypes - a List of FieldType

返回:

Builder

另请参阅:

FieldType

addFieldType

public CreateCollectionParam.Builder addFieldType(@NonNull
                                                  @NonNull FieldType fieldType)

Adds a field schema.

参数:

fieldType - a FieldType object

返回:

Builder

另请参阅:

FieldType

build

public CreateCollectionParam build()
                            throws ParamException

Verifies parameters and creates a new CreateCollectionParam instance.

返回:

CreateCollectionParam

抛出:

ParamException