query()
This operation conducts a query on the entity scalar field(s) with a boolean expression.
Request Syntax
query(
expr: str,
output_fields: List[str] | None,
timeout: float | None,
**kwargs
)
PARAMETERS:
expr (string) -
[REQUIRED]
A boolean expression to filter the entity scalar fields.
output_fields (List[str] | None) -
A list of the names of fields that has to be contained in the output. Setting this to None indicates that this operation only outputs the primary key field.
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.
kwargs:
Additional keyword arguments.
consistency_level (str | int) -
The consistency level of the target collection.
The value defaults to the one specified when you create the current collection, with options of Strong (0), Bounded (1), Session (2), and Eventually (3).
what is the consistency level?
Consistency in a distributed database specifically refers to the property that ensures every node or replica has the same view of data when writing or reading data at a given time.
Milvus supports four consistency levels: Strong, Bounded Staleness, Session, and Eventually. The default consistency level in Milvus is bounded staleness.
You can easily tune the consistency level when conducting a vector similarity search or query to make it best suit your application.
guarantee_timestamp (int) -
A valid timestamp.
If this parameter is set, Milvus executes the query only if all entities inserted before this timestamp are visible to query nodes.
notes
This parameter is valid when the default consistency level applies.
graceful_time (int) -
A period of time in seconds.
The value defaults to 5. If this parameter is set, Milvus calculates the guarantee timestamp by subtracting this from the current timestamp.
notes
This parameter is valid when a consistency level other than the default one applies.
offset (int) -
The number of records to skip in the query result.
You can use this parameter in combination with
limitto enable pagination.The sum of this value and
limitshould be less than 16,384.limit (int) -
The number of records to return in the query result.
You can use this parameter in combination with
offsetto enable pagination.The sum of this value and
offsetshould be less than 16,384.
RETURN TYPE:
List
RETURNS:
A list of the query results.
EXCEPTIONS:
MilvusException
This arises when any error occurs during this operation.
Examples
from pymilvus import Collection, Partition, 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
)
# Create a partition
partition = Partition(collection, name="test_collection")
# Insert a list of columns
res = partition.insert(
data=[
[0,1,2,3,4,5,6,7,8,9], # id
[ # vector
[0.1,0.2,-0.3,-0.4,0.5],
[0.3,-0.1,-0.2,-0.6,0.7],
[-0.6,-0.3,0.2,0.8,0.7],
[0.6,0.2,-0.3,-0.8,0.5],
[0.3,0.1,-0.2,-0.6,-0.7],
[0.1,0.2,-0.3,-0.4,0.5],
[0.3,-0.1,-0.2,-0.6,0.7],
[-0.6,-0.3,0.2,0.8,0.7],
[0.6,0.2,-0.3,-0.8,0.5],
[0.3,0.1,-0.2,-0.6,-0.7],
],
]
)
# Query without any scalar filtering condition
# This query returns entities with their ids from 0 to 4.
res = partition.query(
expr="",
limit=5,
)
# Query with pagination
# This query returns entities with their ids from 5 to 9.
res = partition.query(
expr="",
offset=5
limit=5
)
# Query with a scalar filtering condition
res = partition.query(
expr="id in [6,7,8]",
)
# Query with specified output fields
res = partition.query(
expr="id in [6,7,8]",
output_fields=["id", "vector"],
)
# Query with a customized consistency level
res = partition.query(
expr="",
consistency_level=3,
graceful_time=6
)
Related operations
The following operations are related to query():