Uses of Class com.couchbase.client.java.search.SearchQuery (Couchbase Java SDK)

Packages that use SearchQuery
Package	Description
com.couchbase.client.java
com.couchbase.client.java.search
com.couchbase.client.java.search.core
com.couchbase.client.java.util.rawQuerying

Uses of SearchQuery in com.couchbase.client.java

Methods in com.couchbase.client.java with parameters of type SearchQuery
Modifier and Type	Method	Description
`rx.Observable<AsyncSearchQueryResult>`	AsyncBucket.`query(SearchQuery query)`	Queries a Full-Text Index The returned `Observable` can error under the following conditions: - The producer outpaces the SDK: `BackpressureException` - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: `RequestCancelledException`
`rx.Observable<AsyncSearchQueryResult>`	AsyncBucket.`query(SearchQuery query, long timeout, TimeUnit timeUnit)`	Queries a Full-Text Index The returned `Observable` can error under the following conditions: - The producer outpaces the SDK: `BackpressureException` - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: `RequestCancelledException`
`SearchQueryResult`	Bucket.`query(SearchQuery query)`	Queries a Full-Text Index This method throws under the following conditions: - The producer outpaces the SDK: `BackpressureException` - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: `RequestCancelledException`
`SearchQueryResult`	Bucket.`query(SearchQuery query, long timeout, TimeUnit timeUnit)`	Queries a Full-Text Index This method throws under the following conditions: - The producer outpaces the SDK: `BackpressureException` - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: `RequestCancelledException`
`rx.Observable<AsyncSearchQueryResult>`	CouchbaseAsyncBucket.`query(SearchQuery query)`
`rx.Observable<AsyncSearchQueryResult>`	CouchbaseAsyncBucket.`query(SearchQuery query, long timeout, TimeUnit timeUnit)`
`SearchQueryResult`	CouchbaseBucket.`query(SearchQuery query)`
`SearchQueryResult`	CouchbaseBucket.`query(SearchQuery query, long timeout, TimeUnit timeUnit)`

Uses of SearchQuery in com.couchbase.client.java.search

Methods in com.couchbase.client.java.search that return SearchQuery
Modifier and Type	Method	Description
`SearchQuery`	SearchQuery.`addFacet(String facetName, SearchFacet facet)`	Adds one `SearchFacet` to the query.
`SearchQuery`	SearchQuery.`clearFacets()`	Clears all previously added `SearchFacet`.
`SearchQuery`	SearchQuery.`clearHighlight()`	Clears any previously configured highlighting.
`SearchQuery`	SearchQuery.`consistentWith(Document... docs)`	Sets the consistency to consider for this FTS query to AT_PLUS and uses the mutation information from the given documents to parameterize the consistency.
`SearchQuery`	SearchQuery.`consistentWith(MutationState mutationState)`	Sets the consistency to consider for this FTS query to AT_PLUS and uses the `MutationState` directly to parameterize the consistency.
`SearchQuery`	SearchQuery.`consistentWith(DocumentFragment... fragments)`	Sets the consistency to consider for this FTS query to AT_PLUS and uses the mutation information from the given document fragments to parameterize the consistency.
`SearchQuery`	SearchQuery.`explain()`	Activates the explanation of each result hit in the response.
`SearchQuery`	SearchQuery.`explain(boolean explain)`	Activates or deactivates the explanation of each result hit in the response, according to the parameter.
`SearchQuery`	SearchQuery.`fields(String... fields)`	Configures the list of fields for which the whole value should be included in the response.
`SearchQuery`	SearchQuery.`highlight()`	Configures the highlighting of matches in the response for all fields, using the server's default highlighting style.
`SearchQuery`	SearchQuery.`highlight(HighlightStyle style, String... fields)`	Configures the highlighting of matches in the response.
`SearchQuery`	SearchQuery.`highlight(String... fields)`	Configures the highlighting of matches in the response, for the specified fields and using the server's default highlighting style.
`SearchQuery`	SearchQuery.`limit(int limit)`	Add a limit to the query on the number of hits it can return.
`SearchQuery`	SearchQuery.`searchConsistency(SearchConsistency consistency)`	Sets the unparameterized consistency to consider for this FTS query.
`SearchQuery`	SearchQuery.`serverSideTimeout(long timeout, TimeUnit unit)`	Sets the server side timeout.
`SearchQuery`	SearchQuery.`skip(int skip)`	Set the number of hits to skip (eg.
`SearchQuery`	SearchQuery.`sort(Object... sort)`	Configures the list of fields (including special fields) which are used for sorting purposes.

Uses of SearchQuery in com.couchbase.client.java.search.core

Methods in com.couchbase.client.java.search.core with parameters of type SearchQuery
Modifier and Type	Method	Description
`rx.Observable<AsyncSearchQueryResult>`	SearchQueryExecutor.`execute(SearchQuery query, long timeout, TimeUnit timeUnit)`	Executes the given `SearchQuery`.

Uses of SearchQuery in com.couchbase.client.java.util.rawQuerying

Methods in com.couchbase.client.java.util.rawQuerying with parameters of type SearchQuery
Modifier and Type	Method	Description
`rx.Observable<JsonObject>`	AsyncRawQueryExecutor.`ftsToJsonObject(SearchQuery query)`	Asynchronously perform a `SearchQuery` and return the raw N1QL response as a `JsonObject`.
`JsonObject`	RawQueryExecutor.`ftsToJsonObject(SearchQuery query)`	Synchronously perform a `SearchQuery` and return the raw N1QL response as a `JsonObject`.
`<T> rx.Observable<T>`	AsyncRawQueryExecutor.`ftsToRawCustom(SearchQuery query, rx.functions.Func1<String,T> deserializer)`	Asynchronously perform a `SearchQuery` and apply a user function to deserialize the raw JSON FTS response, which is represented as a `String`.
`<T> T`	RawQueryExecutor.`ftsToRawCustom(SearchQuery query, rx.functions.Func1<String,T> deserializer)`	Synchronously perform a `SearchQuery` and apply a user function to deserialize the raw JSON FTS response, which is represented as a `String`.
`rx.Observable<String>`	AsyncRawQueryExecutor.`ftsToRawJson(SearchQuery query)`	Asynchronously perform a `SearchQuery` and return the raw N1QL response as a String.
`String`	RawQueryExecutor.`ftsToRawJson(SearchQuery query)`	Synchronously perform a `SearchQuery` and return the raw N1QL response as a String.