Package io.milvus.param.dml

Class QueryParam.Builder

java.lang.Object
io.milvus.param.dml.QueryParam.Builder
Enclosing class:
QueryParam
public static class QueryParam.Builder extends Object
Builder for QueryParam class.

  • Method Details

    • withDatabaseName

      public QueryParam.Builder withDatabaseName(String databaseName)
      Sets the database name. database name can be nil.
      Parameters:
      databaseName - database name
      Returns:
      Builder

    • withCollectionName

      public QueryParam.Builder withCollectionName(@NonNull @NonNull String collectionName)
      Sets the collection name. Collection name cannot be empty or null.
      Parameters:
      collectionName - collection name
      Returns:
      Builder

    • withConsistencyLevel

      public QueryParam.Builder withConsistencyLevel(ConsistencyLevelEnum consistencyLevel)
      ConsistencyLevel of consistency level.
      Parameters:
      consistencyLevel - consistency level
      Returns:
      Builder

    • withPartitionNames

      public QueryParam.Builder withPartitionNames(@NonNull @NonNull List<String> partitionNames)
      Sets partition names list to specify query scope (Optional).
      Parameters:
      partitionNames - partition names list
      Returns:
      Builder

    • addPartitionName

      public QueryParam.Builder addPartitionName(@NonNull @NonNull String partitionName)
      Adds a partition to specify query scope (Optional).
      Parameters:
      partitionName - partition name
      Returns:
      Builder

    • withOutFields

      public QueryParam.Builder withOutFields(@NonNull @NonNull List<String> outFields)
      Specifies output fields (Optional).
      Parameters:
      outFields - output fields
      Returns:
      Builder

    • addOutField

      public QueryParam.Builder addOutField(@NonNull @NonNull String fieldName)
      Specifies an output field (Optional).
      Parameters:
      fieldName - field name
      Returns:
      Builder

    • withExpr

      public QueryParam.Builder withExpr(@NonNull @NonNull String expr)
      Sets the expression to query entities.
      Parameters:
      expr - filtering expression
      Returns:
      Builder
      See Also:

    • withOffset

      public QueryParam.Builder withOffset(@NonNull @NonNull Long offset)
      Specify a position to return results. Only take effect when the 'limit' value is specified. Default value is 0, start from begin.
      Parameters:
      offset - a value to define the position
      Returns:
      Builder

    • withLimit

      public QueryParam.Builder withLimit(@NonNull @NonNull Long limit)
      Specify a value to control the returned number of entities. Must be a positive value. Default value is 0, will return without limit.
      Parameters:
      limit - a value to define the limit of returned entities
      Returns:
      Builder

    • withIgnoreGrowing

      public QueryParam.Builder withIgnoreGrowing(@NonNull @NonNull Boolean ignoreGrowing)
      Ignore the growing segments to get best query performance. Default is False. For the user case that don't require data visibility.
      Parameters:
      ignoreGrowing - Boolean.TRUE ignore, Boolean.FALSE is not
      Returns:
      Builder

    • withReduceStopForBest

      public QueryParam.Builder withReduceStopForBest(@NonNull @NonNull Boolean reduceStopForBest)
      Adjust the query using iterators to handle offsets more efficiently during the Reduce step. Default is False.
      Parameters:
      reduceStopForBest - Boolean.TRUE ignore, Boolean.FALSE is not
      Returns:
      Builder

    • withIterator

      public QueryParam.Builder withIterator(@NonNull @NonNull Boolean iterator)
      Optimizing specifically for iterators can yield correct data results. Default is False.
      Parameters:
      iterator - Boolean.TRUE ignore, Boolean.FALSE is not
      Returns:
      Builder

    • build

      public QueryParam build() throws ParamException
      Verifies parameters and creates a new QueryParam instance.
      Returns:
      QueryParam
      Throws:
      ParamException