DocIdQuery (Couchbase Java SDK 3.1.7 API)

java.lang.Object

com.couchbase.client.java.search.SearchQuery

com.couchbase.client.java.search.queries.DocIdQuery

public class DocIdQuery
extends SearchQuery

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

Since:: 2.3.0
Author:: Simon Baslé, Michael Nitschinger

Constructor Summary

Constructors

Constructor Description

DocIdQuery(String... docIds)
Method Summary

Modifier and Type Method Description

DocIdQuery boost(double boost)

DocIdQuery docIds(String... docIds)

protected void injectParams(JsonObject input)

Methods inherited from class com.couchbase.client.java.search.SearchQuery
booleanField, booleans, conjuncts, dateRange, disjuncts, docId, export, geoBoundingBox, geoBoundingBox, geoDistance, geoDistance, geoPolygon, injectParamsAndBoost, match, matchAll, matchNone, matchPhrase, numericRange, phrase, prefix, queryString, regexp, term, termRange, toString, wildcard

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- DocIdQuery
  
  public DocIdQuery(String... docIds)
Method Details
- docIds
  
  public DocIdQuery docIds(String... docIds)
- boost
  
  public DocIdQuery boost(double boost)
  
  Overrides:
  
  boost in class SearchQuery
- injectParams
  
  protected void injectParams(JsonObject input)
  
  Specified by:
  
  injectParams in class SearchQuery