addCollectionField()

This operation adds a new scalar field to an existing collection without recreating it. The field becomes available almost immediately with minimal delay due to internal schema synchronization.

public void addCollectionField(AddCollectionFieldReq request)

Request Syntax

addCollectionField(AddCollectionFieldReq.builder()
    .collectionName(String collectionName)
    .databaseName(String databaseName)
    .build()
);

BUILDER METHODS:

  • collectionName(String collectionName) -

    The name of the target collection.

  • databaseName(String databaseName) -

    The name of the database. Defaults to the current database if not specified.

RETURNS:

void

EXCEPTIONS:

  • MilvusClientException

    This exception will be raised when any error occurs during this operation.

Example

import io.milvus.v2.service.collection.request.AddCollectionFieldReq;
import io.milvus.v2.common.DataType;

// Add a nullable VarChar field to an existing collection.
// The new field must be nullable so that existing rows get null values.
client.addCollectionField(AddCollectionFieldReq.builder()
        .collectionName("my_collection")
        .fieldName("text")
        .dataType(DataType.VarChar)
        .maxLength(100)
        .isNullable(true)
        .build());

Try Managed Milvus for Free

Zilliz Cloud is hassle-free, powered by Milvus and 10x faster.

Get Started
Feedback

Was this page helpful?