Packages

object SearchCount

Counting options. You may use the $$SEARCH_META variable, e.g., via Projections.computedSearchMeta, to extract the results of counting.

Annotations
@Beta()
Since

4.7

See also

Counting

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchCount
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def lowerBound(): LowerBoundSearchCount

    Returns a SearchCount that instructs to count documents exactly only up to LowerBoundSearchCount.threshold.

    Returns a SearchCount that instructs to count documents exactly only up to LowerBoundSearchCount.threshold.

    returns

    The requested SearchCount.

  2. def of(count: Bson): SearchCount

    Creates a SearchCount from a Bson in situations when there is no builder method that better satisfies your needs.

    Creates a SearchCount from a Bson in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.

    Example
    The following code creates two functionally equivalent SearchCounts, though they may not be equal.

    val count1: SearchCount = SearchCount.lowerBound()
    val count2: SearchCount = SearchCount.of(Document("type" -> "lowerBound"))
    count

    A Bson representing the required SearchCount.

    returns

    The requested SearchCount.

  3. def total(): TotalSearchCount

    Returns a SearchCount that instructs to count documents exactly.

    Returns a SearchCount that instructs to count documents exactly.

    returns

    The requested SearchCount.