release_partitions()
This operation releases the partitions in a specified collection from memory.
Request syntax
release_partitions(
collection_name: str,
partition_names: str | List[str],
timeout: Optional[float] = None
) -> None
PARAMETERS:
-
collection_name (str) -
[REQUIRED]
The name of an existing collection.
-
partition_names (str | list[str]) -
[REQUIRED]
A list of the names of the partitions to release.
-
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
📘Notes
A collection is in the loaded state only if any or all of its partitions are loaded.
EXCEPTIONS:
-
MilvusException
This exception will be raised when any error occurs during this operation.
Example
from pymilvus import MilvusClient
# 1. Create a milvus client
client = MilvusClient(
uri="https://inxx-xxxxxxxxxxxx.api.gcp-us-west1.zillizcloud.com:19530",
token="user:password"
)
# 2. Create a collection and get its load status
client.create_collection(collection_name="test_collection", dimension=5)
res = client.get_load_state(
collection_name="test_collection"
)
print(res)
# {'state': <LoadState: Loaded>}
# 3. Create a partition
client.create_partition(
collection_name="test_collection",
partition_name="partition_A"
)
# 4. Check the load status of the partition
res = client.get_load_state(
collection_name="test_collection",
partition_name="partition_A",
)
print(res)
# {'state': <LoadState: Loaded>}
# 5. Release the partition
client.release_partitions(
collection_name="test_collection",
partition_names=["partition_A"]
)
# 6. Check the load status
res = client.get_load_state(
collection_name="test_collection",
partition_name="partition_A"
)
print(res)
# {'state': <LoadState: NotLoad>}
res = client.get_load_state(
collection_name="test_collection"
)
# {'state': <LoadState: Loaded>}