Class FieldType.Builder

Method Detail

• withName

  public FieldType.Builder withName​(@NonNull
                                    @NonNull java.lang.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.

  Parameters:

  primaryKey - true is primary key, false is not

  Returns:

  Builder

• withDescription

  public FieldType.Builder withDescription​(@NonNull
                                           @NonNull java.lang.String description)

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

  Parameters:

  description - description of the field

  Returns:

  Builder

• withDataType

  public FieldType.Builder withDataType​(@NonNull
                                        @NonNull io.milvus.grpc.DataType dataType)

  Sets the data type for the field.

  Parameters:

  dataType - data type of the field

  Returns:

  Builder

• addTypeParam

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

  Adds a parameter pair for the field.

  Parameters:

  key - parameter key

  value - parameter value

  Returns:

  Builder

• withTypeParams

  public FieldType.Builder withTypeParams​(@NonNull
                                          @NonNull java.util.Map<java.lang.String,​java.lang.String> typeParams)

  Sets more parameters for the field.

  Parameters:

  typeParams - parameters of the field

  Returns:

  Builder

• withDimension

  public FieldType.Builder withDimension​(@NonNull
                                         @NonNull java.lang.Integer dimension)

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

  Parameters:

  dimension - dimension of the field

  Returns:

  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.

  Parameters:

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

  Returns:

  Builder

• build

  public FieldType build()
                  throws ParamException

  Verifies parameters and creates a new FieldType instance.

  Returns:

  FieldType

  Throws:

  ParamException