object SearchQuery

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

Value Members

  1. def boolean: BooleanQuery

    A compound FTS query that allows various combinations of sub-queries.

  2. def booleanField(value: Boolean): BooleanFieldQuery

    An FTS query that queries fields explicitly indexed as boolean.

  3. def conjuncts(queries: SearchQuery*): ConjunctionQuery

    A compound FTS query that performs a logical AND between all its sub-queries (conjunction).

  4. def dateRange: DateRangeQuery

    An FTS query that matches documents on a range of dates.

    An FTS query that matches documents on a range of dates. At least one bound is required, and the parser to use for the date (in String form) can be customized.

  5. def disjuncts(queries: SearchQuery*): DisjunctionQuery

    A compound FTS query that performs a logical OR between all its sub-queries (disjunction).

    A compound FTS query that performs a logical OR between all its sub-queries (disjunction). It requires that a configurable minimum of the queries match (the default is 1).

  6. def docId(docIds: String*): DocIdQuery

    An FTS query that matches on Couchbase document IDs.

    An FTS query that matches on Couchbase document IDs. Useful to restrict the search space to a list of keys (by using this in an AbstractCompoundQuery compound query).

    docIds

    list of document IDs to be restricted against. At least one ID is required.

  7. def geoBoundingBox(topLeftLon: Double, topLeftLat: Double, bottomRightLon: Double, bottomRightLat: Double): GeoBoundingBoxQuery

    An FTS query which finds all matches within a given box (identified by the upper left and lower right corner coordinates).

    An FTS query which finds all matches within a given box (identified by the upper left and lower right corner coordinates).

    topLeftLon

    the longitude of the top-left point of the box

    topLeftLat

    the latitude of the top-left point of the box

    bottomRightLon

    the longitude of the bottom-right point of the box

    bottomRightLat

    the latitude of the bottom-right point of the box

  8. def geoDistance(locationLon: Double, locationLat: Double, distance: String): GeoDistanceQuery

    An FTS query that finds all matches from a given location (point) within the given distance.

    An FTS query that finds all matches from a given location (point) within the given distance.

    locationLon

    the location's longitude

    locationLat

    the location's latitude

    distance

    the distance to search from the location, e.g. "10mi"

  9. def geoPolygon(coordinates: Seq[Coordinate]): GeoPolygonQuery
  10. def matchAll: MatchAllQuery

    An FTS query that matches all indexed documents (usually for debugging purposes).

  11. def matchNone: MatchNoneQuery

    An FTS query that matches 0 document (usually for debugging purposes).

  12. def matchPhrase(matchPhrase: String): MatchPhraseQuery

    An FTS query that matches several given terms (a "phrase"), applying further processing like analyzers to them.

    An FTS query that matches several given terms (a "phrase"), applying further processing like analyzers to them.

    matchPhrase

    The input phrase to be matched against.

  13. def matchQuery(matchStr: String): MatchQuery

    An FTS query that matches a given term, applying further processing to it like analyzers, stemming and even fuzziness.

    An FTS query that matches a given term, applying further processing to it like analyzers, stemming and even fuzziness.

    matchStr

    input string to be matched against.

    Since

    1.0.0

  14. def numericRange: NumericRangeQuery

    An FTS query that matches documents on a range of values.

    An FTS query that matches documents on a range of values. At least one bound is required, and the inclusiveness of each bound can be configured.

  15. def phrase(terms: String*): PhraseQuery

    An FTS query that matches several terms (a "phrase") as is.

    An FTS query that matches several terms (a "phrase") as is. The order of the terms matter and no further processing is applied to them, so they must appear in the index exactly as provided. Usually for debugging purposes, prefer MatchPhraseQuery.

    terms

    The mandatory list of terms that must exactly match in the index. Must contain at least one term.

  16. def prefix(prefix: String): PrefixQuery

    An FTS query that allows for simple matching on a given prefix.

  17. def queryString(query: String): QueryStringQuery

    An FTS query that performs a search according to the "query string" syntax.

    An FTS query that performs a search according to the "query string" syntax.

    query

    The query string to be analyzed and used against.

  18. def regexp(regexp: String): RegexpQuery

    An FTS query that allows for simple matching of regular expressions.

    An FTS query that allows for simple matching of regular expressions.

    regexp

    The regexp to be analyzed and used against.

  19. def term(term: String): TermQuery

    Prepare a TermQuery body.

  20. def termRange: TermRangeQuery

    An FTS query that matches documents on a range of values.

    An FTS query that matches documents on a range of values. At least one bound is required, and the inclusiveness of each bound can be configured.

    At least one of min and max must be provided.

  21. def wildcard(wildcard: String): WildcardQuery

    An FTS query that allows for simple matching using wildcard characters (* and ?).