milvus-logo

Class QueryParam.Builder

  • java.lang.Object
    • io.milvus.param.dml.QueryParam.Builder
  • Enclosing class:
    QueryParam

    public static class QueryParam.Builder
    extends java.lang.Object
    Builder for QueryParam class.
    • Method Detail

      • withCollectionName

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

        public QueryParam.Builder withPartitionNames​(@NonNull
                                                     @NonNull java.util.List<java.lang.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 java.lang.String partitionName)
        Adds a partition to specify query scope (Optional).
        Parameters:
        partitionName - partition name
        Returns:
        Builder
      • withOutFields

        public QueryParam.Builder withOutFields​(@NonNull
                                                @NonNull java.util.List<java.lang.String> outFields)
        Specifies output fields (Optional).
        Parameters:
        outFields - output fields
        Returns:
        Builder
      • addOutField

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

        public QueryParam.Builder withExpr​(@NonNull
                                           @NonNull java.lang.String expr)
        Sets the expression to query entities.
        Parameters:
        expr - filtering expression
        Returns:
        Builder
        See Also:
        Boolean Expression Rules
      • withTravelTimestamp

        public QueryParam.Builder withTravelTimestamp​(@NonNull
                                                      @NonNull java.lang.Long ts)
        Specify an absolute timestamp in a query to get results based on a data view at a specified point in time. Default value is 0, server executes query on a full data view.
        Parameters:
        ts - a timestamp value
        Returns:
        Builder
      • withGuaranteeTimestamp

        public QueryParam.Builder withGuaranteeTimestamp​(@NonNull
                                                         @NonNull java.lang.Long ts)
        Instructs server to see insert/delete operations performed before a provided timestamp. If no such timestamp is specified, the server will wait for the latest operation to finish and query. Note: The timestamp is not an absolute timestamp, it is a hybrid value combined by UTC time and internal flags. We call it TSO, for more information please refer to: https://github.com/milvus-io/milvus/blob/master/docs/design_docs/milvus_hybrid_ts_en.md You can get a TSO from insert/delete operations, see the MutationResultWrapper class. Use an operation's TSO to set this parameter, the server will execute query after this operation is finished. Default value is GUARANTEE_EVENTUALLY_TS, query executes query immediately.
        Parameters:
        ts - a timestamp value
        Returns:
        Builder