Class DocIdQuery
- 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 acompound query).- Since:
- 2.3.0
- Author:
- Simon Baslé, Michael Nitschinger
-
-
Constructor Summary
Constructors Constructor Description DocIdQuery(String... docIds)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocIdQueryboost(double boost)DocIdQuerydocIds(String... docIds)protected voidinjectParams(JsonObject input)Override to inject query-specific parameters when doing theSearchQuery.export().-
Methods inherited from class com.couchbase.client.java.search.queries.AbstractFtsQuery
injectParamsAndBoost, toString
-
-
-
-
Constructor Detail
-
DocIdQuery
public DocIdQuery(String... docIds)
-
-
Method Detail
-
docIds
public DocIdQuery docIds(String... docIds)
-
boost
public DocIdQuery boost(double boost)
- Overrides:
boostin classAbstractFtsQuery
-
injectParams
protected void injectParams(JsonObject input)
Description copied from class:AbstractFtsQueryOverride to inject query-specific parameters when doing theSearchQuery.export().- Specified by:
injectParamsin classAbstractFtsQuery- Parameters:
input- the preparedJsonObjectthat will represent the query.
-
-