CreateCollection()

This method creates a collection.

func (c *Client) CreateCollection(ctx context.Context, option CreateCollectionOption, callOptions ...grpc.CallOption) error

Request Parameters

Parameter	Description	Type
ctx	Context for the current call to work.	context.Context
option	Optional parameters of the methods.	CreateCollectionOption
callOpts	Optional parameters for calling the methods.	grpc.CallOption

CreateCollectionOption

This is an interface type. The createCollectionOption struct type implements this interface type.

You can use the NewCreateCollectionOption() or SimpleCreateCollectionOptions() function to get the concrete implementation.

NewCreateCollectionOption

The signature of this method is as follows:

func NewCreateCollectionOption(name string, collectionSchema *entity.Schema) *createCollectionOption

Parameter	Description	Type
name	Name of the collection to create.	string
collectionSchema	Schema of the collection. This parameter applies when creating a collection with a custom schema.	*entity.Schema

You can chain the following methods to append more parameters to the createCollectionOption struct.

• WithShardNum

• WithIndexOptions

• WithProperty

• WithConsistencyLevel

• WithIndexOptions

SimpleCreateCollectionOptions

This method outputs the options for creating a collection in a quick-setup manner. The signature of this method is as follows:

func SimpleCreateCollectionOptions(name string, dim int64) *createCollectionOption

Parameter	Description	Type
name	Name of the collection to create.	string
dim	Dimensionality of the vector field.	int64

You can chain the following methods to append more parameters to the createCollectionOption struct.

• WithAutoID

• WithDynamicSchema

• WithVarcharPK

• WithIndexOptions

WithAutoID

This method appends the settings regarding the autoID parameter to the createCollectionOption struct. The signature of the method is as follows:

func (opt *createCollectionOption) WithAutoID(autoID bool) *createCollectionOption

Parameter	Description	Type
autoID	Whether to allow Milvus to automatically allocate the primary keys for incoming entities.	bool

WithShardNum

This method appends the settings regarding the shardNum parameter to the createCollectionOption struct. The signature of the method is as follows:

func (opt *createCollectionOption) WithShardNum(shardNum int32) *createCollectionOption

Parameter	Description	Type
shardNum	Number of shards to create along with the collection. A shard corresponds to a data input channel.	int32

WithDynamicSchema

This method appends the settings regarding the enableDynamicField parameter to the createCollectionOption struct. The signature of the method is as follows:

func (opt *createCollectionOption) WithDynamicSchema(dynamicSchema bool) *createCollectionOption

Parameter	Description	Type
enableDynamicSchema	Whether to enable the dynamic field. If set to true, non-schema-defined fields and their values in incoming entities will be saved as key-value pairs in a reserved field of the JSON type named $meta. For details, refer to Dynamic Field.	bool

WithVarcharPK

This method appends the settings regarding the varcharPK and varcharPKMaxLengthparameters to the createCollectionOption struct. The signature of the method is as follows:

func (opt *createCollectionOption) WithVarcharPK(varcharPK bool, maxLen int) *createCollectionOption

Parameter	Description	Type
varcharPK	Whether to use a primary key of the VarChar type. This parameter applies when creating a collection in a quick-setup manner.	bool
maxLen	Maximum length for the primary key of the VarChar type. This parameter applies only when varcharPK is set to true.	int

WithIndexOptions

This method appends the settings regarding the indexOptions parameter to the createCollectionOption struct. The signature of the method is as follows:

func (opt *createCollectionOption) WithIndexOptions(indexOpts ...CreateIndexOption) *createCollectionOption

Parameter	Description	Type
indexOptions	Index options. This parameter applies when creating a collection with a custom schema. Once set, Milvus automatically loads the collection after it is created.	[]CreateIndexOption

WithProperty

This method appends the settings regarding the properties parameter to the createCollectionOption struct. The signature of the method is as follows:

func (opt *createCollectionOption) WithProperty(key string, value any) *createCollectionOption

Parameter	Description	Type
properties	Other collection properties.	map[string]string

WithConsistencyLevel

This method appends the settings regarding the consistencyLevel parameter to the createCollectionOption struct. The signature of the method is as follows:

func (opt *createCollectionOption) WithConsistencyLevel(cl entity.ConsistencyLevel) *createCollectionOption

Parameter	Description	Type
consistencyLevel	Consistency level of the collection. For details, refer to Consistency Level.	entity.ConsistencyLevel

entity.Schema

You can use the entity.NewSchema method to get the concrete implementation of the entity.Schema struct type.

entity.NewSchema

This method creates an empty schema. You can chain the following methods to append corresponding parameters to the created schema.

• WithAutoID

• WithDescription

• WithDynamicFieldEnabled

• WithField

• WithFunction

• WithName

entity.WithAutoID

This method appends the settings regarding the autoID parameter to the entity.Schema struct. The signature of the method is as follows:

func (s *entity.Schema) WithAutoID(autoID bool) *entity.Schema

Parameter	Description	Type
autoID	Whether the primary keys of the incoming entities automatically increments.	bool

entity.WithDescription

This method appends the schema description to the entity.Schema struct. The signature of the method is as follows:

func (s *entity.Schema) WithDescription(desc string) *entity.Schema

Parameter	Description	Type
desc	Description of the schema.	string

entity.WithDynamicFieldEnabled

The method appends the settings regarding the EnableDynamicField to the entity.Schema struct. The signature of the method is as follows:

func (s *entity.Schema) WithDynamicFieldEnabled(dynamicEnabled bool) *entity.Schema

Parameter	Description	Type
dynamicEnabled	Whether to enable the dynamic field. If set to true, non-schema-defined fields and their values in incoming entities will be saved as key-value pairs in a reserved field of the JSON type named $meta. For details, refer to Dynamic Field.	bool

entity.WithField

The method appends a field object to the entity.Schema struct. The signature of the method is as follows:

func (s *entity.Schema) WithField(f *entity.Field) *entity.Schema

Parameter	Description	Type
f	An entity.Field object.	*entity.Field

entity.WithFunction

The method appends a function object to the entity.Schema struct. The signature of the method is as follows:

func (s *entity.Schema) WithFunction(f *entity.Function) *entity.Schema

Parameter	Description	Type
f	An entity.Function object.	*entity.Function

entity.WithName

The method appends the schema name to the entity.Schema struct. The signature of the method is as follows:

func (s *Schema) WithName(name string) *Schema

Parameter	Description	Type
name	Name of the schema.	string

entity.Field

You can use the entity.NewField method to get the concrete implementation of the entity.Field struct type.

entity.NewField

This method creates an empty field schema. You can chain the following methods to append corresponding parameters to the created field schema.

• WithAnalyzerParams

• WithDataType

• WithDefaultValueBool

• WithDefaultValueDouble

• WithDefaultValueFloat

• WithDefaultValueInt

• WithDefaultValueLong

• WithDefaultValueString

• WithDescription

• WithDim

• WithElementType

• WithEnableAnalyzer

• WithIsAutoID

• WithIsClusteringKey

• WithIsDynamic

• WithIsPartitionKey

• WithIsPrimaryKey

• WithMaxCapacity

• WithMaxLength

• WithName

• WithNullable

• WithTypeParams

entity.WithAnalyzerParams

This method appends analyzer parameters in key-value pairs to the entity.Field struct. The signature of the method is as follows:

func (f *Field) WithAnalyzerParams(params map[string]any) *Field

Parameter	Description	Type
params	Analyzer parameters of the current field in key-value pairs. An analyzer is a crucial component that converts raw text into a structured, searchable format. For details, refer to Analyzer Overview.	map[string]any

entity.WithDataType

This method appends the data type property to the entity.Field struct. The signature of the method is as follows:

func (f *Field) WithDataType(dataType FieldType) *Field

Parameter	Description	Type
dataType	Data type of the current field. Possible values are as follows: entity.FieldTypeBool entity.FieldTypeInt8 entity.FieldTypeInt16 entity.FieldTypeInt32 entity.FieldTypeInt64 entity.FieldTypeFloat entity.FieldTypeDouble entity.FieldTypeVarChar entity.FieldTypeArray entity.FieldTypeJSON entity.FieldTypeBinaryVector entity.FieldTypeFloatVector entity.FieldTypeFloat16Vector entity.FieldTypeBFloat16Vector entity.FieldTypeSparseVector entity.FieldTypeInt8Vector	entity.FieldType

entity.WithDefaultValueBool

This method sets the default value for the field of the entity.FieldTypeBool type. The signature of the method is as follows:

func (f *Field) WithDefaultValueBool(defaultValue bool) *Field

Parameter	Description	Type
defaultValue	Default value when the argument of the entity.WithDataType method is set to entity.FieldTypeBool.	bool

entity.WithDefaultValueDouble

This method sets the default value for the field of the entity.FieldTypeDouble type. The signature of the method is as follows:

func (f *Field) WithDefaultValueDouble(defaultValue float64) *Field

Parameter	Description	Type
defaultValue	Default value when the argument of the entity.WithDataType method is set to entity.FieldTypeDouble.	float64

entity.WithDefaultValueFloat

This method sets the default value for the field of the entity.FieldTypeFloat type. The signature of the method is as follows:

func (f *Field) WithDefaultValueFloat(defaultValue float32) *Field

Parameter	Description	Type
defaultValue	Default value when the argument of the entity.WithDataType method is set to entity.FieldTypeFloat.	float32

entity.WithDefaultValueInt

This method sets the default value for the field of the entity.FieldTypeLong type. The signature of the method is as follows:

func (f *Field) WithDefaultValueInt(defaultValue int64) *Field

Parameter	Description	Type
defaultValue	Default value when the argument of the entity.WithDataType method is set to entity.FieldTypeLong.	int32

entity.WithDefaultValueLong

This method sets the default value for the field of the entity.FieldTypeInt type. The signature of the method is as follows:

func (f *Field) WithDefaultValueLong(defaultValue int64) *Field

Parameter	Description	Type
defaultValue	Default value when the argument of the entity.WithDataType method is set to entity.FieldTypeInt.	int64

entity.WithDefaultValueString

This method sets the default value for the field of the entity.FieldTypeVarChar type. The signature of the method is as follows:

func (f *Field) WithDefaultValueString(defaultValue string) *Field

Parameter	Description	Type
defaultValue	Default value when the argument of the entity.WithDataType method is set to entity.FieldTypeVarChar.	string

entity.WithDescription

This method sets the field description. The signature of the method is as follows:

func (f *Field) WithDescription(desc string) *Field

Parameter	Description	Type
desc	Description of the field.	string

entity.Dim

This method sets the dimensionality for a vector field. The signature of the method is as follows:

func (f *Field) WithDim(dim int64) *Field

Parameter	Description	Type
dim	Dimensionality of a vector field	int64

entity.WithElementType

This methods set the data type for the elements in an array field. The signature of the method is as follows:

func (f *Field) WithElementType(eleType FieldType) *Field

Parameter	Description	Type
eleType	Data type for the elements in an array field. Possible values are as follows: entity.FieldTypeBool entity.FieldTypeInt8 entity.FieldTypeInt16 entity.FieldTypeInt32 entity.FieldTypeInt64 entity.FieldTypeFloat entity.FieldTypeDouble entity.FieldTypeVarChar	entity.FieldType

entity.WithEnableAnalyzer

This method determines whether to enable the analyzer for the current field. The signature of the method is as follows:

func (f *Field) WithEnableAnalyzer(enable bool) *Field

Parameter	Description	Type
enable	Whether to enable the analyzer for the current field. An analyzer is a crucial component that converts raw text into a structured, searchable format. For details, refer to Analyzer Overview.	bool

entity.WithIsAutoID

This method determines whether the primary key automatically increments. The signature of the method is as follows：

func (f *Field) WithIsAutoID(isAutoID bool) *Field

Parameter	Description	Type
autoID	Whether the primary key automatically increments. This method applies only when you also append the entity.WithIsPrimaryKey to the field creation request.	bool

entity.WithIsClusteringKey

This method determines whether the current field serves as the clustering key, which guides Milvus to implement clustering compaction. For details, refer to Clustering Compaction. The signature of the method is as follows:

func (f *Field) WithIsClusteringKey(isClusteringKey bool) *Field

Parameter	Description	Type
isClusteringKey	Whether the current field serves as the cluster key.	bool

entity.WithIsDynamic

This method determines whether the current field serves as the dynamic field.

A dynamic field should be a field of the JSON type and you can store non-schema-defined fields and their values in key-value pairs in it. For details, refer to Dynamic Field.

The signature of this method is as follows:

func (f *Field) WithIsDynamic(isDynamic bool) *Field

Parameter	Description	Type
isDynamic	Whether the current field serves as the dynamic field. This method applies only when you also append the entity.WithDataType method to the field creation request and set the dataType parameter to entity.FieldTypeJSON.	bool

entity.WithIsPartitionKey

This method determines whether the current field serves as the partition key.

A partition key serves as a guidance for Zilliz Cloud to determine how to allocate the incoming entities. For details, refer to Use Partition Key.

The signature of this method is as follows:

func (f *Field) WithIsPartitionKey(isPartitionKey bool) *Field

Parameter	Description	Type
isPartitionKey	Whether the current field serves as the partition key.	bool

entity.WithIsPrimaryKey

This method determines whether the current field serves as the primary key. The signature of this method is as follows:

func (f *Field) WithIsPrimaryKey(isPrimaryKey bool) *Field

Parameter	Description	Type
isPrimaryKey	Whether the current field serves as the primary key.	bool

entity.WithMaxCapacity

This method sets the maximum number of elements in an array field. The signature of this method is as follows:

func (f *Field) WithMaxCapacity(maxCap int64) *Field

Parameter	Description	Type
maxCap	Maximum number of elements in an array field. This method applies only when you also append the entity.WithDataType method to the field creation request and set the dataType parameter to entity.FieldTypeArray.	int64

entity.WithMaxLength

This method sets the maximum length of a VarChar field. The signature of this method is as follows:

func (f *Field) WithMaxLength(maxLen int64) *Field

Parameter	Description	Type
maxCap	Maximum length of a VarChar field. This method applies only when you also append the entity.WithDataType method to the field creation request and set the dataType parameter to entity.FieldTypeVarChar.	int64

entity.WithName

This method sets the name of the current field. The signature of this method is as follows:

func (f *Field) WithName(name string) *Field

Parameter	Description	Type
name	Name of the current field.	string

entity.WithNullable

This method determines whether the current field allows null values. The signature of this method is as follows:

func (f *Field) WithNullable(nullable bool) *Field

Parameter	Description	Type
nullable	Whether the current field allows null values.	bool

entity.WithTypeParams

This method sets additional parameters for specific data types in a key-value pair. The signature of this method is as follows:

func (f *Field) WithTypeParams(key string, value string) *Field

Parameter	Description	Type
key	Name of the parameter to set	string
value	Value of the specified parameter	string

entity.Function

You can use the entity.NewFunction method to get the concrete implementation of the entity.Funtion struct type.

entity.NewFunction

This method creates an empty function. You can chain the following methods to append corresponding parameters to the created field schema.

• WithInputFields

• WithName

• WithOutputFields

• WithParam

• WithType

entity.WithInputFields

This method specifies the input field names. The data contained in the specified input field requires conversion to vector representation.

func (f *Function) WithInputFields(inputFields ...string) *Function

Parameter	Description	Type
inputFields	Names of the fields that contain the data to be converted to its vector representation.	...string

entity.Name

This method specifies the name of the function.

func (f *Function) WithName(name string) *Function

Parameter	Description	Type
name	Name of the current function.	string

entity.WithOutputFields

This method specifies the output field name. Milvus calls the function to create the output field and insert the vector representation of the data in the specified input field.

func (f *Function) WithOutputFields(outputFields ...string) *Function

Parameter	Description	Type
outputFields	Names of the fields to create after you call the function.	...string

entity.WithParam

This method adds an additional parameter to the current function.

func (f *Function) WithParam(key string, value any) *Function

Parameter	Description	Type
key	Name of the additional parameter.	string
value	Value of the additional parameter.	any

entity.Type

This method specifies the type of the current function.

func (f *Function) WithType(funcType FunctionType) *Function

Parameter	Description	Type
funcType	Type of the current function.	FunctionType

entity.ConsistencyLevel

This is a private type that has the following possible values.

const (
        ClStrong ConsistencyLevel = ConsistencyLevel(commonpb.ConsistencyLevel_Strong)
        ClBounded ConsistencyLevel = ConsistencyLevel(commonpb.ConsistencyLevel_Bounded)
        ClSession ConsistencyLevel = ConsistencyLevel(commonpb.ConsistencyLevel_Session)
        ClEventually ConsistencyLevel = ConsistencyLevel(commonpb.ConsistencyLevel_Eventually)
        ClCustomized ConsistencyLevel = ConsistencyLevel(commonpb.ConsistencyLevel_Customized)
)

entity.MetricType

This is a string type that has the following possible values:

const (
        L2             MetricType = "L2"
        IP             MetricType = "IP"
        COSINE         MetricType = "COSINE"
        HAMMING        MetricType = "HAMMING"
        JACCARD        MetricType = "JACCARD"
        TANIMOTO       MetricType = "TANIMOTO"
        SUBSTRUCTURE   MetricType = "SUBSTRUCTURE"
        SUPERSTRUCTURE MetricType = "SUPERSTRUCTURE"
        BM25           MetricType = "BM25"
)

entity.FunctionType

This is a private type that has the following possible values.

const (
        FunctionTypeUnknown       = schemapb.FunctionType_Unknown
        FunctionTypeBM25          = schemapb.FunctionType_BM25
        FunctionTypeTextEmbedding = schemapb.FunctionType_TextEmbedding
)

Return

Null

Example

• Quick setup

  ctx, cancel := context.WithCancel(context.Background())
  defer cancel()
  
  collectionName := `quick_setup_1`
  cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
      Address: milvusAddr,
  })
  if err != nil {
      // handle err
  }
  
  err = cli.CreateCollection(ctx, milvusclient.SimpleCreateCollectionOptions(collectionName, 512))
  if err != nil {
      // handle error
  }

• Custom setup with index parameters

  ctx, cancel := context.WithCancel(context.Background())
  defer cancel()
  
  collectionName := `quick_setup_2`
  cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
      Address: milvusAddr,
  })
  if err != nil {
      // handle err
  }
  
  err = cli.CreateCollection(ctx, milvusclient.SimpleCreateCollectionOptions(collectionName, 512).WithIndexOptions(
      milvusclient.NewCreateIndexOption(collectionName, "vector", index.NewHNSWIndex(entity.L2, 64, 128)),
  ))
  if err != nil {
      log.Println(err.Error())
      // handle error
  }

• Custom setup without index parameters

  ctx, cancel := context.WithCancel(context.Background())
  defer cancel()
  
  collectionName := `quick_setup_3`
  cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
      Address: milvusAddr,
  })
  if err != nil {
      // handle err
  }
  
  err = cli.CreateCollection(ctx, milvusclient.SimpleCreateCollectionOptions(collectionName, 512).
      WithVarcharPK(true, 64).
      WithShardNum(1),
  )
  if err != nil {
      log.Println(err.Error())
      // handle error
  }