QueryParameters

A set of optional parameters for performing a query.

public sealed class QueryParameters
{
    public int? Limit { get; set; }
    public int? Offset { get; set; }
    public ConsistencyLevel? ConsistencyLevel { get; set; }
    public ulong? GuaranteeTimestamp { get; set; }
    public ulong? TimeTravelTimestamp { get; set; }
    public IList<string> PartitionNames { get; }
    public IList<string> OutputFields { get; }
    public bool? IgnoreGrowing { get; set; }
    public string? Timezone { get; set; }
    public IDictionary<string, object> FilterTemplates { get; }
    public IReadOnlyList<object>? Ids { get; set; }
    public IDictionary<string, string> ExtraParameters { get; }
}

PARAMETERS:

  • Limit (int?) -

    The maximum number of rows to return. The sum of this value and Offset must be between 1 and 16384.

  • Offset (int?) -

    The number of rows to skip. The sum of this value and Limit must be between 1 and 16384.

  • ConsistencyLevel (ConsistencyLevel?) -

    The consistency level to be used in the query. Defaults to the consistency level configured for the collection. See ConsistencyLevel.

  • GuaranteeTimestamp (ulong?) -

    If set, guarantees that the query is performed after any updates up to the provided timestamp.

  • TimeTravelTimestamp (ulong?) -

    Specifies an optional time travel timestamp; the query gets results based on the data at that point in time.

  • PartitionNames (IList) -

    An optional list of partitions to be queried in the collection. Entries are added via the collection-initializer syntax PartitionNames = { ... }.

  • OutputFields (IList) -

    The names of the fields to be returned from the query. Entries are added via the collection-initializer syntax OutputFields = { ... }.

  • IgnoreGrowing (bool?) -

    Whether to ignore the growing segments during the query.

  • Timezone (string?) -

    The timezone used for the query, e.g. "+08:00" or "America/New_York".

  • FilterTemplates (IDictionary) -

    Named expression-template values used by the query’s filter expression, for parameterized filters; placeholders are written with curly braces inside the expression. Entries are added via the collection-initializer syntax FilterTemplates = { ... }.

  • Ids (IReadOnlyList?) -

    The primary key values identifying the rows to return. Mutually exclusive with the query’s expression; when set, an expression is generated from the collection’s primary key field.

  • ExtraParameters (IDictionary) -

    Additional query parameters passed through to the server verbatim, mirroring the Java SDK’s QueryReq.queryParams map. Entries are added via the collection-initializer syntax ExtraParameters = { ... }.

  • Example

    using Milvus.Client.V2;
    using Milvus.Client.V2.Requests.Dql;
    using Milvus.Client.V2.Responses.Dql;
    using Milvus.Client.V2.Types;
    
    using var client = new MilvusClientV2(new ConnectConfig
    {
        Uri = "localhost:19530",
        Username = "root",
        Password = "Milvus"
    });
    
    QueryResp results = await client.QueryAsync(new QueryReq
    {
        CollectionName = "my_collection",
        Expression = "pages > {minPages}",
        Parameters = new QueryParameters
        {
            Limit = 10,
            OutputFields = { "title", "pages" },
            ConsistencyLevel = ConsistencyLevel.Bounded,
            FilterTemplates = { ["minPages"] = 100 }
        }
    });
    

    Try Managed Milvus for Free

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

    Get Started
    Feedback

    Was this page helpful?