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 DocIdQuery
boost(double boost)
DocIdQuery
docIds(String... docIds)
protected void
injectParams(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:
boost
in classAbstractFtsQuery
-
injectParams
protected void injectParams(JsonObject input)
Description copied from class:AbstractFtsQuery
Override to inject query-specific parameters when doing theSearchQuery.export()
.- Specified by:
injectParams
in classAbstractFtsQuery
- Parameters:
input
- the preparedJsonObject
that will represent the query.
-
-