Schema

Defines a Milvus v3 collection schema, validates struct-array fields, and supports external collection source configuration.

type Schema struct {
    CollectionName string
    Description string
    AutoID bool
    Fields []*Field
    EnableDynamicField bool
    Functions []*Function
    ExternalSource string
    ExternalSpec string
}

Request Syntax

Creates an empty collection schema.

entity.NewSchema()

METHODS:

• WithName(name string) *Schema

  This sets the collection name.

• WithDescription(desc string) *Schema

  This sets the collection description.

• WithAutoID(autoID bool) *Schema

  This sets whether Milvus automatically generates primary keys.

• WithDynamicFieldEnabled(dynamicEnabled bool) *Schema

  This enables or disables the dynamic field.

• WithExternalSource(externalSource string) *Schema

  This sets the external data source URI.

• WithExternalSpec(externalSpec string) *Schema

  This sets the external source configuration as JSON.

• WithField(field *Field) *Schema

  This appends a field definition to the schema.

• WithFunction(function *Function) *Schema

  This appends a built-in function definition to the schema.

• Validate() error

  This validates struct-array sub-fields and returns an error for unsupported nesting or top-level-only flags.

• PKFieldName() string

  This returns the primary-key field name.

• PKField() *Field

  This returns the primary-key field definition.

• WithExternalSource(externalSource string)

  This sets the source data URI, which is similar to an AWS S3 object path.

• WithExternalSpec(externalSpec string)

  The external source specifications, which are a set of secondary parameters:

  • format (string) -

    The format of the target source data files.

    Possible values are parquet, vortex, lance-table, and iceberg-table.

  • extfs (string) -

    External file system settings in a stringified JSON structure.

    Possible options are as follows:

    • access_key_id (string) -

      The access key ID of your object storage service.

    • access_key_val (string) -

      The access key value of your object storage service.

    • cloud_provider (string) -

      The cloud provider of your object storage service.

    • region (string) -

      The region of your object storage service.

    • use_iam (string) -

      Whether to use AWS IAM for bucket access authentication.

      Possible values are "true" or "false".

    • iam_endpoint (string) -

      The AWS IAM STS endpoint.

    • use_ssl (string) -

      Whether to use SSL to access your object storage bucket.

      Possible values are "true" or "false".

    • use_virtual_host (string) -

      Whether to use virtual hosting for bucket access.

      For details, refer to this article.

    • storage_type (string) -

      The storage type. Possible values is remote.

    • role_arn (string) -

      The AWS IAM Role ARN that is obtained from the bucket owner.

    • external_id (string) -

      The external ID obtained from the bucket owner.

    • load_frequency (string) -

      The interval at which Milvus retrieves temporary authentication credentials in seconds.

RETURN TYPE:

Schema

RETURNS:

Represents the schema of a collection, including field definitions, functions, and dynamic field settings.

• CollectionName (string) -

  This stores the collection name.

• Description (string) -

  This stores the collection description.

• AutoID (bool) -

  This indicates whether Milvus automatically generates primary keys.

• Fields ([]Field*) -

  This contains the collection field definitions.

• EnableDynamicField (bool) -

  This indicates whether the dynamic field is enabled.

• Functions ([]Function*) -

  This contains the built-in function definitions.

• ExternalSource (string) -

  External data source (e.g., “s3://bucket/path”).

• ExternalSpec (string) -

  External source config (JSON).

Example

Demonstrates Schema usage.

import (
    "fmt"

    "github.com/milvus-io/milvus/client/v3/entity"
)

structSchema := entity.NewStructSchema().
    WithField(entity.NewField().WithName("embedding").WithDataType(entity.FieldTypeFloatVector).WithDim(8))

schema := entity.NewSchema().
    WithField(entity.NewField().WithName("chunks").WithDataType(entity.FieldTypeArray).WithElementType(entity.FieldTypeStruct).WithStructSchema(structSchema))

err := schema.Validate()
fmt.Println(err)

Notes

• Struct-array decoding preserves nullable state and restores max_capacity from sub-fields when the parent does not carry it.

• ExternalSource and ExternalSpec describe external collection storage and configuration.