DocIdQuery (Couchbase Java SDK)

java.lang.Object

com.couchbase.client.java.search.queries.AbstractFtsQuery

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

@Uncommitted
@Public
public class DocIdQuery
extends AbstractFtsQuery

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)`	Override to inject query-specific parameters when doing the `SearchQuery.export()`.

Methods inherited from class com.couchbase.client.java.search.queries.AbstractFtsQuery

injectParamsAndBoost, toString

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 AbstractFtsQuery
- injectParams
  
  protected void injectParams(JsonObject input)
  
  Description copied from class: AbstractFtsQuery
  
  Override to inject query-specific parameters when doing the SearchQuery.export().
  
  Specified by:
  
  injectParams in class AbstractFtsQuery
  
  Parameters:
  
  input - the prepared JsonObject that will represent the query.