package queries
- Alphabetic
- Public
- Protected
Type Members
- trait AbstractCompoundQuery extends SearchQuery
Base class for FTS queries that are composite, compounding several other SearchQuery.
Base class for FTS queries that are composite, compounding several other SearchQuery.
- Since
1.0.0
- case class BooleanFieldQuery(value: Boolean, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
An FTS query that queries fields explicitly indexed as boolean.
An FTS query that queries fields explicitly indexed as boolean.
- Since
1.0.0
- case class BooleanQuery(must: ConjunctionQuery = ConjunctionQuery(), should: DisjunctionQuery = DisjunctionQuery(), mustNot: DisjunctionQuery = DisjunctionQuery(), field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
A compound FTS query that allows various combinations of sub-queries.
A compound FTS query that allows various combinations of sub-queries.
- Since
1.0.0
- case class ConjunctionQuery(queries: Seq[SearchQuery] = Seq.empty, field: Option[String] = None, boost: Option[Double] = None) extends AbstractCompoundQuery with Product with Serializable
A compound FTS query that performs a logical AND between all its sub-queries (conjunction).
A compound FTS query that performs a logical AND between all its sub-queries (conjunction).
- Since
1.0.0
- case class DateRangeQuery(start: Option[String] = None, inclusiveStart: Option[Boolean] = None, end: Option[String] = None, inclusiveEnd: Option[Boolean] = None, dateTimeParser: Option[String] = None, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
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.
Datetimes can be provided as RFC3339 compliant strings in UTC timezone only, or more conveniently as an
Instant.- Since
1.0.0
- case class DisjunctionQuery(queries: Seq[SearchQuery] = Seq.empty, min: Option[Int] = None, field: Option[String] = None, boost: Option[Double] = None) extends AbstractCompoundQuery with Product with Serializable
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).
- Since
1.0.0
- case class DocIdQuery(docIds: Seq[String], boost: Option[Double] = None) extends SearchQuery with Product with Serializable
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.
- Since
1.0.0
- case class GeoBoundingBoxQuery(topLeftLon: Double, topLeftLat: Double, bottomRightLon: Double, bottomRightLat: Double, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
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
- Since
1.0.0
- case class GeoDistanceQuery(locationLon: Double, locationLat: Double, distance: String, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
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"
- Since
1.0.0
- case class GeoPolygonQuery(coordinates: Seq[Coordinate], field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
An FTS query that finds all matches inside a given search polygon.
An FTS query that finds all matches inside a given search polygon.
- Annotations
- @SinceCouchbase()
- case class MatchAllQuery(field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
An FTS query that matches all indexed documents (usually for debugging purposes).
An FTS query that matches all indexed documents (usually for debugging purposes).
- Since
1.0.0
- case class MatchNoneQuery(field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
An FTS query that matches 0 document (usually for debugging purposes).
An FTS query that matches 0 document (usually for debugging purposes).
- Since
1.0.0
- sealed trait MatchOperator extends AnyRef
Defines how the individual match terms should be logically concatenated.
- case class MatchPhraseQuery(matchPhrase: String, analyzer: Option[String] = None, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
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.
- Since
1.0.0
- case class MatchQuery(matchStr: String, fuzziness: Option[Int] = None, prefixLength: Option[Int] = None, analyzer: Option[String] = None, field: Option[String] = None, boost: Option[Double] = None, operator: Option[MatchOperator] = None) extends SearchQuery with Product with Serializable
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
- case class NumericRangeQuery(min: Option[Double] = None, inclusiveMin: Option[Boolean] = None, max: Option[Double] = None, inclusiveMax: Option[Boolean] = None, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
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.
- Since
1.0.0
- case class PhraseQuery(terms: Seq[String], field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
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.
- Since
1.0.0
- case class PrefixQuery(prefix: String, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
An FTS query that allows for simple matching on a given prefix.
An FTS query that allows for simple matching on a given prefix.
- Since
1.0.0
- case class QueryStringQuery(query: String, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
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.
- Since
1.0.0
- case class RegexpQuery(regexp: String, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
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.
- Since
1.0.0
- trait SearchQuery extends AnyRef
A base class for all FTS query classes.
A base class for all FTS query classes. Exposes the common FTS query parameters. In order to instantiate various flavors of queries, look at concrete classes or static factory methods in com.couchbase.client.scala.search.SearchOptions.
- Since
1.0.0
- case class TermQuery(term: String, fuzziness: Option[Int] = None, prefixLength: Option[Int] = None, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
An FTS query that matches terms (without further analysis).
An FTS query that matches terms (without further analysis). Usually for debugging purposes, prefer using MatchQuery.
- term
the exact string that will be searched for in the index
- Since
1.0.0
- case class TermRangeQuery(min: Option[String] = None, inclusiveMin: Option[Boolean] = None, max: Option[String] = None, inclusiveMax: Option[Boolean] = None, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
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.
- Since
1.0.0
- case class WildcardQuery(wildcard: String, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
An FTS query that allows for simple matching using wildcard characters (* and ?).
An FTS query that allows for simple matching using wildcard characters (* and ?).
- Since
1.0.0
Value Members
- object MatchOperator
- object SearchQuery