io.milvus.param.collection

类 FieldType.Builder

java.lang.Object

io.milvus.param.collection.FieldType.Builder

封闭类:

FieldType

public static final class FieldType.Builder
extends Object

Builder for FieldType class.

方法概要

限定符和类型	方法和说明
FieldType.Builder	addTypeParam(@NonNull String key, @NonNull String value) Adds a parameter pair for the field.
FieldType	build() Verifies parameters and creates a new FieldType instance.
FieldType.Builder	withAutoID(boolean autoID) Enables auto-id function for the field.
FieldType.Builder	withDataType(@NonNull DataType dataType) Sets the data type for the field.
FieldType.Builder	withDescription(@NonNull String description) Sets the field description.
FieldType.Builder	withDimension(@NonNull Integer dimension) Sets the dimension of a vector field.
FieldType.Builder	withMaxLength(@NonNull Integer maxLength) Sets the max length of a varchar field.
FieldType.Builder	withName(@NonNull String name)
FieldType.Builder	withPrimaryKey(boolean primaryKey) Sets the field as the primary key field.
FieldType.Builder	withTypeParams(@NonNull Map<String,String> typeParams) Sets more parameters for the field.

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

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

方法详细资料

withName

public FieldType.Builder withName(@NonNull
                                  @NonNull String name)

withPrimaryKey

public FieldType.Builder withPrimaryKey(boolean primaryKey)

Sets the field as the primary key field. Note that the current release of Milvus only support Long data type as primary key.

参数:

primaryKey - true is primary key, false is not

返回:

Builder

withDescription

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

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

参数:

description - description of the field

返回:

Builder

withDataType

public FieldType.Builder withDataType(@NonNull
                                      @NonNull DataType dataType)

Sets the data type for the field.

参数:

dataType - data type of the field

返回:

Builder

addTypeParam

public FieldType.Builder addTypeParam(@NonNull
                                      @NonNull String key,
                                      @NonNull
                                      @NonNull String value)

Adds a parameter pair for the field.

参数:

key - parameter key

value - parameter value

返回:

Builder

withTypeParams

public FieldType.Builder withTypeParams(@NonNull
                                        @NonNull Map<String,String> typeParams)

Sets more parameters for the field.

参数:

typeParams - parameters of the field

返回:

Builder

withDimension

public FieldType.Builder withDimension(@NonNull
                                       @NonNull Integer dimension)

Sets the dimension of a vector field. Dimension value must be greater than zero.

参数:

dimension - dimension of the field

返回:

Builder

withMaxLength

public FieldType.Builder withMaxLength(@NonNull
                                       @NonNull Integer maxLength)

Sets the max length of a varchar field. The value must be greater than zero.

参数:

maxLength - max length of a varchar field

返回:

Builder

withAutoID

public FieldType.Builder withAutoID(boolean autoID)

Enables auto-id function for the field. Note that the auto-id function can only be enabled on primary key field. If auto-id function is enabled, Milvus will automatically generate unique ID for each entity, thus you do not need to provide values for the primary key field when inserting. If auto-id is disabled, you need to provide values for the primary key field when inserting.

参数:

autoID - true enable auto-id, false disable auto-id

返回:

Builder

build

public FieldType build()
                throws ParamException

Verifies parameters and creates a new FieldType instance.

返回:

FieldType

抛出:

ParamException