Back to Milvus

Design Document: Drop Collection Field / Function

docs/design-docs/design_docs/20260413-drop-collection-field-design.md

3.0.038.7 KB
Original Source

Design Document: Drop Collection Field / Function

Branch: feat/drop-collection-field Author: sijie-ni-0214 Date: May 2026 Scope: 40 files, +3,852/-1,067 lines


1. Overview

1.1 Motivation

Schema evolution is essential for production vector databases. While Milvus already supports adding function fields via AlterCollectionSchema (PR #48810), there is no mechanism to remove obsolete fields or functions from a collection schema. Users who added experimental BM25 fields, deprecated scalar columns, or misconfigured function fields must currently recreate the entire collection and re-ingest all data.

This feature enables users to dynamically drop fields and functions from existing collection schemas without data re-ingestion, completing the schema evolution lifecycle alongside the existing add-field capability.

1.2 Key Requirements

  1. Non-disruptive schema evolution: Drop fields/functions without collection recreation
  2. Backward compatibility: Existing segments with dropped-field data must remain loadable and queryable
  3. Cascade cleanup: Indexes on dropped fields must be automatically removed
  4. Field ID safety: Dropped field IDs must never be reused to prevent data corruption
  5. Concurrency safety: Use the existing schema DDL execution path
  6. Unified API: Integrate into the existing AlterCollectionSchema RPC rather than introducing a separate RPC

1.3 Design Principles

  • Schema-driven filtering: All components use the latest schema to determine field accessibility; dropped fields are invisible without deleting underlying data
  • Lazy cleanup: Binlogs of dropped fields are not immediately deleted; they are simply skipped during segment loading
  • Inline cascade: Index deletion executes within the broadcast ack callback to avoid deadlocks, following the same pattern as DropCollection
  • ID monotonicity: A persistent max_field_id property ensures field IDs only increase, even after drops

2. Architecture Overview

2.1 High-Level Data Flow

+------------------------------------------------------------------------------+
|                      AlterCollectionSchema (DropRequest)                      |
+------------------------------------------------------------------------------+
                                        |
                                        v
+------------------------------------------------------------------------------+
|                                   PROXY                                      |
|  * Validate drop constraints (not PK, not partition key, not last vector...) |
|  * Forward to RootCoord via MixCoord                                         |
+------------------------------------------------------------------------------+
                                        |
                                        v
+------------------------------------------------------------------------------+
|                                ROOTCOORD                                     |
|  * Build new schema (remove field/function, increment version)               |
|  * Persist max_field_id to collection properties                             |
|  * Broadcast AlterCollectionMessage to WAL (control + virtual channels)      |
|  * Ack callback: cascade drop indexes on dropped fields                      |
+------------------------------------------------------------------------------+
                                        |
                    +-------------------+-------------------+
                    v                                       v
+----------------------------------+   +-----------------------------------+
|       QUERYNODE (Go + C++)       |   |            DATACOORD              |
| * Segment loader: skip binlogs   |   | * DropIndex: tolerate dropped     |
|   and indexes for dropped fields |   |   fields (skip vector-index       |
| * C++ segcore: has_field() check |   |   validation when field is nil)   |
|   in ComputeDiff*, LoadFieldData |   |                                   |
| * Parquet reader: skip columns   |   |                                   |
|   not in field_metas             |   |                                   |
+----------------------------------+   +-----------------------------------+

2.2 Component Responsibilities

ComponentResponsibility
ProxyRequest validation and DDL scheduling
RootCoordSchema construction, field ID management, WAL broadcast, cascade index deletion
QueryNode (Go)Filter dropped-field binlogs and indexes during segment loading
Segcore (C++)Schema-driven field filtering in ComputeDiff*, LoadFieldData, column group loading
DataCoordTolerate dropped fields in DropIndex flow; skip vector-index validation for nil fields

2.3 What This Feature Does NOT Change

The drop field feature reuses the existing AlterCollectionSchema infrastructure without modifying:

  • Streaming/WAL layer: No new message types; uses existing AlterCollectionMessage
  • DataNode: No backfill; dropped-field binlogs are left in place

3. API Design

3.1 RPC Endpoint

Drop field/function uses the existing AlterCollectionSchema RPC with a new DropRequest action:

protobuf
rpc AlterCollectionSchema(AlterCollectionSchemaRequest) returns (AlterCollectionSchemaResponse) {}

3.2 Proto Message Changes

DropRequest Definition

protobuf
message AlterCollectionSchemaRequest {
    // ... existing fields (db_name, collection_name, etc.)

    message DropRequest {
        oneof identifier {
            string field_name = 1;     // Drop field by name
            int64 field_id = 2;        // Drop field by ID
            string function_name = 3;  // Drop function by name
        }
        bool drop_function_output_fields = 4;  // With function_name, also drop
                                                // supported output fields
    }

    message Action {
        oneof op {
            AddRequest add_request = 1;    // Existing: add field/function
            DropRequest drop_request = 2;  // New: drop field/function
        }
    }

    Action action = 5;
}

AlterCollectionMessage Extension

protobuf
// messages.proto - AlterCollectionMessageHeader
message AlterCollectionMessageHeader {
    // ... existing fields (db_id, collection_id, update_mask, etc.)
    repeated int64 dropped_field_ids = 6;  // Field IDs removed from schema,
                                            // used to cascade-delete indexes
                                            // in ack callback. Empty when
                                            // detaching a function.
}

UpdateMask Difference: Drop vs Add

OperationUpdateMask Fields
Add (field/function)schema + properties
Drop (field/function)schema + properties

Schema mutations update properties because they maintain max_field_id to prevent field ID reuse.

3.3 Client SDK (pymilvus)

python
def drop_collection_field(
    self,
    collection_name: str,
    *,
    field_name: str = "",       # Drop by field name
    field_id: int = 0,          # Drop by field ID
    db_name: str = "",
    timeout: Optional[float] = None,
) -> None:
    """Drop a field from the collection schema."""

def drop_collection_function(
    self,
    collection_name: str,
    function_name: str,
    *,
    db_name: str = "",
    timeout: Optional[float] = None,
) -> None:
    """Detach a function and keep its output fields as normal fields."""

def drop_function_field(
    self,
    collection_name: str,
    function_name: str,
    *,
    db_name: str = "",
    timeout: Optional[float] = None,
) -> None:
    """Drop a supported function and its output fields."""

4. Component Design Details

4.1 Proxy Layer

Files: internal/proxy/impl.go, internal/proxy/task.go

Scheduling and Validation

Drop operations use the standard Proxy DDL path:

  1. Current schema validation: Proxy calls DescribeCollection and passes the current schema into alterCollectionSchemaTask for local validation.

  2. DDL Queue: The task is enqueued on ddQueue.

PreExecute: Drop Validation

go
func (t *alterCollectionSchemaTask) preExecuteDrop(ctx context.Context) error {
    dropReq := t.GetAction().GetDropRequest()

    switch id := dropReq.GetIdentifier().(type) {
    case *milvuspb.AlterCollectionSchemaRequest_DropRequest_FunctionName:
        return validateDropFunction(
            t.oldSchema,
            id.FunctionName,
            dropReq.GetDropFunctionOutputFields(),
        )
    case *milvuspb.AlterCollectionSchemaRequest_DropRequest_FieldId:
        // Resolve field ID across top-level fields and struct array fields.
        // Struct sub-field drops are rejected.
        return validateDropFieldByID(t.oldSchema, id.FieldId)
    case *milvuspb.AlterCollectionSchemaRequest_DropRequest_FieldName:
        return validateDropField(t.oldSchema, id.FieldName)
    }
}

validateDropField Constraints

ConstraintError Message
Field name is emptyfield name is empty
Field not found in schemafield not found: {name}
System field ($rowid, $timestamp, $meta, $namespace)cannot drop system field: {name}
Primary key fieldcannot drop primary key field: {name}
Partition key fieldcannot drop partition key field: {name}
Clustering key fieldcannot drop clustering key field: {name}
Dynamic field (IsDynamic=true)cannot drop dynamic field: {name}, use AlterCollection to disable dynamic schema instead
Last vector field in schemacannot drop the last vector field: {name}
Field is function inputfield is referenced by function {fn} as input
Field is function outputfield is referenced by function {fn} as output, drop function first
Target is a sub-field of a struct array fieldcannot drop sub-field of struct array field: {struct}.{sub}
Dropping whole struct array field would leave no vectorcannot drop struct array field {name}: it would leave no vector field in the collection

Struct array field scope:

  • Dropping a whole struct array field by name or ID is supported; it is equivalent to batch-dropping the struct entry plus all its sub-fields (droppedFieldIds covers the struct ID and every sub-field ID). The existing index cascade and segcore has_field() filtering cover the removal without any C++ changes.
  • Dropping an individual sub-field is not supported in this change. Milvus has no runtime API for adding a struct array field or an individual sub-field to an existing collection — struct array fields and their sub-fields are declared once at collection creation (neither add_collection_field nor AlterCollectionSchema.AddRequest accepts a struct-shaped payload). Dropping a single sub-field would therefore be asymmetric with no restore path, and is explicitly rejected.

validateDropFunction Constraints

ConstraintError Message
Function name is emptyfunction name is empty
Function not foundfunction not found: {name}
BM25 function is detached without dropping its output fieldBM25 function must be dropped with its output field in drop_function_field interface: {name}
Output-field drop is requested for an unsupported function typeonly BM25 and MinHash functions support dropping output fields: {name}
Output-field drop would leave no vector in schemacannot drop function {name}: it would leave no vector field in the collection

4.2 RootCoord Layer

File: internal/rootcoord/ddl_callbacks_alter_collection_schema.go

broadcastAlterCollectionSchemaDrop

1. Resolve identifier to target (field or function)
      |
      v
2. Build new schema:
   * buildSchemaForDropField(coll, fieldName, fieldID)
     OR buildSchemaForDetachFunction(coll, functionName)
     OR buildSchemaForDropFunctionField(coll, functionName)
      |
      v
3. Returns: (newSchema, newProperties, droppedFieldIds)
      |
      v
4. Broadcast AlterCollectionMessage:
   * UpdateMask: [schema, properties]
   * Body: { schema, properties, droppedFieldIds }
   * Channels: control channel + all virtual channels
      |
      v
5. Ack Callback:
   a. meta.AlterCollection() -- persist metadata
   b. cascadeDropFieldIndexesInline() -- delete indexes
   c. BroadcastAlteredCollection() -- notify proxies
   d. ExpireCaches() -- invalidate metadata caches

buildSchemaForDropField

go
func buildSchemaForDropField(coll *model.Collection, fieldName string, fieldID int64) (
    *schemapb.CollectionSchema, []*commonpb.KeyValuePair, []int64, error,
) {
    // 1. Locate target field by name or ID
    var targetField *model.Field
    for _, field := range coll.Fields {
        if (fieldName != "" && field.Name == fieldName) ||
           (fieldID > 0 && field.FieldID == fieldID) {
            targetField = field
            break
        }
    }

    // 2. Persist max_field_id to prevent ID reuse
    maxFieldID := nextFieldID(coll) - 1
    properties := updateMaxFieldIDProperty(coll.Properties, maxFieldID)

    // 3. Build new schema without the target field
    newFields := []*schemapb.FieldSchema{}
    for _, field := range coll.Fields {
        if field.FieldID != targetField.FieldID {
            newFields = append(newFields, marshal(field))
        }
    }

    schema := &schemapb.CollectionSchema{
        Fields:    newFields,
        Functions: marshalFunctions(coll.Functions),
        Version:   coll.SchemaVersion + 1,
    }

    return schema, properties, []int64{targetField.FieldID}, nil
}

buildSchemaForDetachFunction

Detaches a function while keeping its output fields in the schema as normal fields:

go
func buildSchemaForDetachFunction(coll *model.Collection, functionName string) (
    *schemapb.CollectionSchema, []*commonpb.KeyValuePair, []int64, error,
) {
    // 1. Find target function
    var targetFunc *model.Function
    for _, fn := range coll.Functions {
        if fn.Name == functionName { targetFunc = fn; break }
    }

    // 2. BM25 output fields are internal generated fields and are not detached.
    if targetFunc.Type == schemapb.FunctionType_BM25 {
        return nil, nil, nil, err
    }

    // 3. Keep output fields but clear IsFunctionOutput.
    outputFieldIDSet := set(targetFunc.OutputFieldIDs)
    newFields := marshalFields(coll.Fields)
    for _, field := range newFields {
        if outputFieldIDSet[field.FieldID] {
            field.IsFunctionOutput = false
        }
    }

    // 4. Remove function from schema.
    newFunctions := filterFunctions(coll.Functions, targetFunc.Name)

    // 5. Keep existing properties, increment schema version.
    // ...

    return schema, coll.Properties, nil, nil
}

buildSchemaForDropFunctionField

Drops a supported function and its output fields:

go
func buildSchemaForDropFunctionField(coll *model.Collection, functionName string) (
    *schemapb.CollectionSchema, []*commonpb.KeyValuePair, []int64, error,
) {
    // 1. Find target function
    var targetFunc *model.Function
    for _, fn := range coll.Functions {
        if fn.Name == functionName { targetFunc = fn; break }
    }

    // 2. Only BM25 and MinHash expose output-field drop semantics.
    switch targetFunc.Type {
    case schemapb.FunctionType_BM25, schemapb.FunctionType_MinHash:
    default:
        return nil, nil, nil, err
    }

    // 3. Collect output field IDs as droppedFieldIds.
    droppedFieldIds := targetFunc.OutputFieldIDs
    outputFieldIDSet := set(droppedFieldIds)

    // 4. Remove output fields and function from schema.
    newFields := filterFields(coll.Fields, outputFieldIDSet)
    newFunctions := filterFunctions(coll.Functions, targetFunc.Name)

    // 5. Persist max_field_id, increment schema version.
    // ...

    return schema, properties, droppedFieldIds, nil
}

4.3 Field ID Reuse Prevention

Problem: If field IDs are assigned based on max(current_fields), dropping the field with the highest ID would cause the next added field to reuse that ID. Since binlogs of the dropped field still exist on storage with the old field ID, this creates data corruption.

Solution: Persist max_field_id in collection properties.

go
// nextFieldID reads max field ID from three sources and returns max + 1:
func nextFieldID(coll *model.Collection) int64 {
    maxFieldID := int64(common.StartOfUserFieldID)  // 100

    // Source 1: Current fields
    for _, field := range coll.Fields {
        if field.FieldID > maxFieldID { maxFieldID = field.FieldID }
    }

    // Source 2: Struct array sub-fields
    for _, sf := range coll.StructArraySubFields { /* ... */ }

    // Source 3: Persisted max_field_id (survives field deletion)
    for _, kv := range coll.Properties {
        if kv.Key == "max_field_id" {
            if v, err := strconv.ParseInt(kv.Value, 10, 64); err == nil {
                if v > maxFieldID { maxFieldID = v }
            }
        }
    }

    return maxFieldID + 1
}

Key: updateMaxFieldIDProperty is called during every field-removing drop operation, ensuring the high-water mark is persisted even if the field with the highest ID is removed. Detaching a function does not remove fields, so it keeps the existing collection properties.

4.4 Cascade Index Deletion

File: internal/rootcoord/ddl_callbacks_alter_collection_properties.go

Why Inline in Ack Callback?

broadcastAlterCollectionSchema() holds a broadcast lock on the collection. Calling DropIndex as a separate RPC would attempt to acquire the same lock, causing a deadlock. Instead, index deletion is executed inline within the ack callback (the same pattern used by DropCollection).

cascadeDropFieldIndexesInline

go
func cascadeDropFieldIndexesInline(ctx context.Context, c *Core, msg *msgstream.AlterCollectionMsg) error {
    droppedFieldIDs := msg.Body.Updates.DroppedFieldIds
    if len(droppedFieldIDs) == 0 {
        return nil  // No fields dropped, nothing to cascade
    }

    // 1. Query all indexes on the collection
    resp, err := c.mixCoord.DescribeIndex(ctx, &indexpb.DescribeIndexRequest{
        CollectionID: msg.CollectionID,
    })

    // 2. Find indexes on dropped fields
    droppedSet := make(map[int64]bool)
    for _, id := range droppedFieldIDs { droppedSet[id] = true }

    for _, index := range resp.IndexInfos {
        if droppedSet[index.FieldID] {
            // 3. Broadcast DropIndex message via control channel
            registry.CallMessageAckCallback(ctx, DropIndexMessage{
                IndexID: index.IndexID,
                // ...
            })
        }
    }
    return nil
}

DataCoord Tolerance for Dropped Fields

When cascadeDropFieldIndexesInline triggers DropIndex, the field no longer exists in the schema. The DataCoord DropIndex handler must tolerate this:

go
// internal/datacoord/index_service.go
field := typeutil.GetField(schema, index.FieldID)
if field == nil {
    // Field already dropped from schema -- skip vector-index validation,
    // proceed with index cleanup
    log.Info("field already dropped, proceeding with index drop")
    continue
}

Without this tolerance, the cascade would fail because DropIndex normally validates that vector indexes cannot be dropped on loaded collections.

4.5 Disable Dynamic Field

Disabling the dynamic schema (AlterCollection with EnableDynamicField=false) reuses the drop-field infrastructure:

go
func broadcastDisableDynamicField(ctx context.Context, coll *model.Collection) error {
    // 1. Find the $meta (dynamic) field
    var dynamicFieldID int64
    for _, field := range coll.Fields {
        if field.IsDynamic { dynamicFieldID = field.FieldID; break }
    }

    // 2. Build schema without $meta, set EnableDynamicField=false
    // 3. Broadcast with DroppedFieldIds = [dynamicFieldID]
    // 4. Ack callback: cascadeDropFieldIndexesInline removes $meta indexes
}

Requests that alter unrelated properties (e.g., collection.ttl.seconds, mmap.enabled) keep the existing property-only path.

4.6 Segcore (C++) Layer

Files: internal/core/src/segcore/SegmentLoadInfo.cpp, ChunkedSegmentSealedImpl.cpp, SegmentGrowingImpl.cpp

Schema-Driven Filtering Strategy

All C++ components use the latest schema (not the segment's original schema) to determine field visibility. The core check is:

cpp
// Schema.h
bool has_field(FieldId field_id) const {
    return fields_.count(field_id) > 0;
}

This single method gates all data access:

FunctionFileBehavior
ComputeDiffBinlogsSegmentLoadInfo.cppSkip binlog entries for dropped fields
ComputeDiffIndexesSegmentLoadInfo.cppSkip index entries for dropped fields
ComputeDiffColumnGroupsSegmentLoadInfo.cppSkip column groups for dropped fields
ComputeDiffReloadFieldsSegmentLoadInfo.cppExclude dropped fields from reload set
LoadFieldDataChunkedSegmentSealedImpl.cppDefense-in-depth: skip if field not in schema
load_field_data_internalSegmentGrowingImpl.cppSkip growing segment data for dropped fields
load_column_group_data_internalSegmentGrowingImpl.cppSkip column groups for dropped fields
TranslateGroupChunkGroupChunkTranslator.cppSkip parquet columns not in field_metas

Key Design Decision: Use new_info.schema_ (the latest schema from the load request) rather than this->schema_ (the segment's cached schema) in all ComputeDiff* functions. This ensures that even if the segment was loaded before the field was dropped, a reload/delta-load will correctly filter out the dropped field.

4.7 QueryNode Segment Loader (Go)

File: internal/querynodev2/segments/segment_loader.go

The Go segment loader filters dropped fields at two points:

go
// Index loading
fieldSchema, err := schemaHelper.GetFieldFromID(fieldID)
if err != nil {
    log.Info("skip index for dropped field", zap.Int64("fieldID", fieldID))
    continue  // Field dropped, skip its index
}

// Binlog/column group loading
fieldSchema, err := schemaHelper.GetFieldFromID(fieldID)
if err != nil {
    log.Info("skip binlog for dropped field", zap.Int64("fieldID", fieldID))
    continue  // Field dropped, skip it
}

Important: The loader uses continue (not return err) to ensure that other fields in the same column group are still loaded correctly.


5. Drop Field vs Drop Function: Semantic Differences

AspectDrop FieldDetach FunctionDrop Function Field
Request shapefield_name / field_idfunction_name, drop_function_output_fields=falsefunction_name, drop_function_output_fields=true
TargetA single fieldFunction metadata onlyFunction metadata + supported output fields
Output fieldsN/APreserved as normal fields with IsFunctionOutput=falseRemoved from schema.Fields
DroppedFieldIds[fieldID][][outputFieldID1, outputFieldID2, ...]
Input fieldsN/APreservedPreserved
Index cascadeDrops indexes on the fieldNo output-field index deletionDrops indexes on removed output fields
ValidationCannot drop if referenced by a functionBM25 functions are not detachableOnly BM25 and MinHash support output-field removal; the collection must retain at least one vector field

Detach Function Contract

Dropping a function with drop_function_output_fields=false only removes the function binding:

  • The target function is removed from schema.Functions.
  • Function output fields remain in schema.Fields.
  • Output fields are converted to normal fields by setting IsFunctionOutput=false.
  • DroppedFieldIds is empty, so no field index deletion is scheduled.
  • Collection properties are forwarded unchanged.

This mode is used for functions whose output fields can exist independently as user-visible data, such as TextEmbedding dense-vector outputs and MinHash materialized BinaryVector outputs.

Drop Function Field Contract

Dropping a function with drop_function_output_fields=true removes the function binding and supported generated/materialized output fields:

  • The target function is removed from schema.Functions.
  • Output fields are removed from schema.Fields.
  • Input fields are preserved.
  • Indexes on removed output fields are deleted through DroppedFieldIds.
  • max_field_id remains pinned to the historical high-water mark.

This mode is supported for BM25 and MinHash functions. BM25 uses an internal generated output field and must use this mode; MinHash supports both detach and output-field removal because its output is a materialized BinaryVector field.


6. Concurrency and Consistency

6.1 Schema Mutation Ordering

Drop operations use the existing schema DDL ordering:

  1. Proxy DDL queue: AlterCollectionSchema tasks are enqueued on ddQueue.

  2. Collection broadcast lock: RootCoord broadcasts the schema mutation under the collection resource key.

  3. Schema-drop readiness: DropRequest operations and dynamic-field disable call waitUntilSchemaDropReady before broadcasting the schema change.

6.2 Ack Callback Idempotency

The ack callback (cascadeDropFieldIndexesInline + meta.AlterCollection) may be retried with exponential backoff if it fails. Both operations are idempotent:

  • meta.AlterCollection: Overwrites metadata; repeated calls produce the same result
  • MarkIndexAsDeleted: Skips already-deleted indexes

6.3 Cascade Intermediate Window

Field-removing drop requests proceed in two phases within the ack-callback pipeline:

  1. Metadata phase: meta.AlterCollection removes the field from coll.Fields. After this step DescribeCollection no longer reports the field.
  2. Index cascade phase: cascadeDropFieldIndexesInline broadcasts DropIndex for each surviving index on the dropped field ID; once those acks complete, indexMeta entries are cleared.

Observable window: Between phase 1 and phase 2 — typically milliseconds, but bounded only by the DropIndex broadcast round-trip — an external observer can see:

  • DescribeCollection → field is gone
  • ListIndexes → an index on the dropped field name is still reported

This state is transient, not an orphaned-index bug. It is equivalent to the window that DropCollection exposes between deleting the collection meta and the cascade cleanup of its indexes.

Retry convergence: cascadeDropFieldIndexesInline is driven by the standard broadcast ack-callback framework — if the DropIndex broadcast fails (network, rootcoord restart, etc.), the ack infrastructure retries until success, and rootcoord re-drives outstanding callbacks from the broadcast log after restart. Final consistency is guaranteed; the window does not accumulate.

On-call diagnosis: to distinguish a transient drop-field cascade window from a true orphaned-index bug:

  • RootCoord logs cascade dropping index on dropped field with fieldID, indexName, indexID for every cascade target; the presence of a recent entry for the observed index confirms the current state is transient.
  • Re-query after ~30s — if ListIndexes still returns the dropped field, the cascade has genuinely failed to converge and should be treated as an orphaned-index bug through the existing runbook.

Detach-function requests carry an empty DroppedFieldIds list. The ack callback persists the function-list update, broadcasts the altered collection, and expires metadata caches without scheduling output-field index deletion.

6.4 In-flight Request Semantics

Segcore's schema-driven filtering (§4.6) gates loading, not query plan compilation or execution. This section specifies how in-flight search / query / groupby requests behave relative to a concurrent drop.

A request "observes" a dropped field only when it actually references the field, through any of:

  • anns_field
  • filter / expression
  • output_fields (explicit or via "*" expansion)
  • group_by_field
  • partition-key expression

Requests that do not reference the dropped field pass through unaffected — plan compilation never looks up the removed field, and the executor never issues a column access for it.

When a request does reference the dropped field, one of three outcomes applies, determined by the race between the proxy's globalMetaCache invalidation and the querynode's segment reload:

CaseProxy cache stateQueryNode segment stateOutcome
1. Post-invalidation (common)new schema (N+1)anyproxy's CreateSearchPlanArgs schema-helper cannot resolve the field; task_search.go wraps the error as ErrParameterInvalid: "failed to create query plan: field not found: <field>" — returned to the client
2. Cross-version (narrow)stale (N)new schema (N+1), segment reloaded without the fieldplan compiles against schema N, reaches querynode; segcore's chunk_data_impl/chunk_array_view_impl check field_data_ready_bitset_, the bit is 0 for the dropped field, AssertInfo raises SegcoreError — surfaced to the client as an error status
3. No racestale or newstill has the fieldexecutes normally

Cases 1 and 2 both return a clear error to the client; neither aborts or corrupts state. Case 2 is bounded in time by the proxy cache invalidation latency (rootcoord broadcast → per-proxy cache invalidate, milliseconds to seconds in practice).

SDKs cache collection schema in a process-wide GlobalCache. Schema-mutating public methods must invalidate this cache on success because client-side request encoding can depend on field metadata. For example, bytes-input search consults the cached anns_field vector type to encode the placeholder; after a field is dropped and re-created with a different type, a stale cache would keep encoding the request with the old type.

All schema-mutating public methods — drop_collection_field, drop_collection_function, drop_function_field, add_collection_field and add_collection_function (sync + async) — invalidate the cache on success, so the next request re-fetches fresh schema from the server.


7. Sequence Diagram

7.1 Drop Field Flow

Client              Proxy           RootCoord        WAL/Streaming      QueryNode (C++)
  |                   |                 |                |                    |
  | AlterCollectionSchema               |                |                    |
  | (DropRequest: field_name="vec2")    |                |                    |
  |------------------>|                 |                |                    |
  |                   |                 |                |                    |
  |                   | validateDropField               |                    |
  |                   | (not PK, not last vector, etc.) |                    |
  |                   |                 |                |                    |
  |                   | AlterCollectionSchema           |                    |
  |                   |---------------->|                |                    |
  |                   |                 |                |                    |
  |                   |                 | buildSchemaForDropField             |
  |                   |                 | (remove field, version+1,          |
  |                   |                 |  persist max_field_id)             |
  |                   |                 |                |                    |
  |                   |                 | Broadcast AlterCollectionMessage   |
  |                   |                 |--------------->|                    |
  |                   |                 |                |                    |
  |                   |                 |         (WAL append + flush)       |
  |                   |                 |                |                    |
  |                   |                 | Ack Callback:  |                    |
  |                   |                 | 1. AlterCollection (persist)       |
  |                   |                 | 2. cascadeDropFieldIndexesInline   |
  |                   |                 |    -> DropIndex for vec2 indexes   |
  |                   |                 | 3. BroadcastAlteredCollection      |
  |                   |                 | 4. ExpireCaches                    |
  |                   |                 |                |                    |
  |                   |<----------------|                |                    |
  |<------------------|                 |                |                    |
  |                   |                 |                |                    |
  |                   |                 |                | (on next load/reload)
  |                   |                 |                |                    |
  |                   |                 |                | ComputeDiffBinlogs |
  |                   |                 |                | has_field("vec2")  |
  |                   |                 |                | -> false, skip     |
  |                   |                 |                |                    |

8. Key Design Decisions

8.1 Lazy Data Cleanup (No Immediate Binlog Deletion)

Decision: Dropped-field binlogs remain on object storage; they are simply skipped during segment loading.

Rationale:

  • Immediate deletion would require scanning all segments for the field's binlogs, which is expensive
  • Binlogs are naturally cleaned up during compaction (compacted segments only contain current-schema fields)
  • Avoids complex rollback logic if deletion fails partway
  • Storage cost is bounded and decreasing (compaction gradually removes stale data)

8.2 Inline Cascade via Ack Callback

Decision: Execute index deletion inline within the broadcast ack callback, not as a separate RPC call.

Rationale:

  • broadcastAlterCollectionSchema() holds a broadcast lock on the collection
  • Calling DropIndex as a separate RPC would deadlock (attempts to acquire the same lock)
  • The ack callback pattern is proven: DropCollection uses the same approach for cascade cleanup
  • Ack callbacks support exponential-backoff retry with idempotent operations

8.3 Persistent max_field_id

Decision: Store the historical maximum field ID in collection properties (max_field_id key).

Rationale:

  • Without this, dropping the highest-ID field would cause nextFieldID() to return an already-used ID
  • Reused field IDs would cause QueryNode to incorrectly load stale binlogs for the new field
  • The property persists through metadata updates and is read by nextFieldID() alongside current field IDs
  • Minimal storage overhead (one key-value pair per collection)

8.4 Unified DropRequest Path

Decision: Use AlterCollectionSchema with DropRequest for field drop, function detach, and function-field drop operations.

Rationale:

  • Reuses the existing schema evolution entry point for schema-level drops
  • Keeps the add/drop schema mutation flow symmetric at Proxy and RootCoord
  • Carries the drop_function_output_fields flag in the same request envelope that identifies the target function
  • Lets field-removing paths share DroppedFieldIds, max-field-ID persistence, and index cleanup behavior

8.5 Schema-Driven Filtering in C++

Decision: Use the new/latest schema (new_info.schema_) for all ComputeDiff* filtering, not the segment's cached schema.

Rationale:

  • The segment's cached schema may predate the drop operation
  • Using the latest schema ensures correct filtering on reload/delta-load
  • Single source of truth: the schema from the load request always reflects current state
  • Defense-in-depth: multiple layers check has_field() to catch edge cases

9. Testing Strategy

9.1 Unit Tests

ComponentTest ScopeTest Count
Proxy: validateDropFieldAll constraint violations (PK, partition key, clustering key, dynamic, last vector, function reference, system field, not found)12
Proxy: preExecuteDropDropRequest by field_name / field_id / function_name, nil action, unknown action11
Proxy: validateDropFunctionEmpty/not found, detach BM25 rejection, detach MinHash success, BM25/MinHash output-field drop, unsupported function type, last-vector protection9
RootCoord: broadcastAlterCollectionSchemaDropFull broadcast flow with ack callback1
RootCoord: buildSchemaForDetachFunctionFunction removal, output fields retained as normal fields, BM25 rejection3
RootCoord: buildSchemaForDropFunctionFieldBM25/MinHash output field removal, unsupported function rejection, droppedFieldIds4
RootCoord: nextFieldIDProperties-based max_field_id, historical collection compat4
RootCoord: updateMaxFieldIDPropertyProperty creation and update4
C++: SegmentLoadInfoComputeDiffBinlogs/Indexes/ColumnGroups with dropped fields8

9.2 E2E Tests

#ScenarioVerification
1Drop scalar field (empty collection)Schema updated, field absent
2Drop scalar field (with data)Query does not return dropped field
3Drop indexed fieldIndex cascade deleted
4Drop one of multiple vector fieldsRemaining vector field searchable
5Insert after dropNew data lacks dropped field, search works
6Drop + add same-name fieldNew field gets different field ID, no crash
7Constraint rejectionPK / partition key / last vector correctly refused
8Dynamic field disable/enableIdempotent toggle, index cascade
9Loaded collection drop + reloadSearch and query work after reload
10Drop BM25 function fieldFunction metadata, output fields, and indexes removed; input preserved
11Detach TextEmbedding / MinHash functionFunction removed, output fields remain queryable as normal fields
12Detach BM25 functionRejected with drop_function_field guidance
13Drop function input fieldRejected (must drop function first)
14Field ID reuse preventionDrop + Add same-name different-type, search old data no crash
15Add + Drop serial interactionSchema remains valid after sequential operations

10. Future Enhancements

10.1 Physical Binlog Cleanup

Add a background GC task that scans object storage and removes binlogs for fields no longer present in any segment's schema.

10.2 Batch Drop

Support dropping multiple fields/functions in a single AlterCollectionSchema request.

10.3 Drop Field with Data Migration

Support dropping a field while migrating its data to another field (e.g., renaming).


11. References