wait_for_compaction_completed()

This operation blocks the current session until the compaction request is completed.

Request Syntax

wait_for_compaction_completed(
    timeout: float | None
)

PARAMETERS:

timeout (float | None)

The timeout duration for this operation. Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.

RETURN TYPE:

NoneType

RETURNS:

None

EXCEPTIONS:

MilvusException

This arises when any error occurs during this operation.

Examples

from pymilvus import Collection, CollectionSchema, FieldSchema, DataType

schema = CollectionSchema([
    FieldSchema("id", DataType.INT64, is_primary=True),
    FieldSchema("vector", DataType.FLOAT_VECTOR, dim=5)
])

# Create a collection
collection = Collection(
    name="test_collection",
    schema=schema
)

# Compact small segments
collection.compact()

# Check the compaction state
collection.wait_for_compaction_completed()

Related operations

The following operations are related to wait_for_compaction_completed():