com.couchbase.client.java.util.rawQuerying

Class RawQueryExecutor

java.lang.Object

com.couchbase.client.java.util.rawQuerying.RawQueryExecutor

@InterfaceStability.Uncommitted
 @InterfaceAudience.Public
public class RawQueryExecutor
extends Object

A utility class that allows to perform N1QL and FTS queries synchronously and receive a raw version of the service’s JSON response.

The responses can directly be exposed as JsonObject or String, but custom methods allow to work from a byte array (for N1QL) or String (for FTS) and perform a custom deserialization.

Note that this class is outside of the Bucket API as it is Uncommitted, and is not common to all Couchbase SDKs.

Since:

2.3

Author:

Simon Baslé

Constructor Summary

Constructors

Constructor and Description
RawQueryExecutor(AsyncRawQueryExecutor async, CouchbaseEnvironment env)
RawQueryExecutor(String bucket, String password, ClusterFacade core, CouchbaseEnvironment env)

Method Summary

Modifier and Type	Method and Description
JsonObject	ftsToJsonObject(SearchQuery query) Synchronously perform a SearchQuery and return the raw N1QL response as a JsonObject.
<T> T	ftsToRawCustom(SearchQuery query, 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.
String	ftsToRawJson(SearchQuery query) Synchronously perform a SearchQuery and return the raw N1QL response as a String.
JsonObject	n1qlToJsonObject(N1qlQuery query) Synchronously perform a N1qlQuery and return the raw N1QL response as a JsonObject.
<T> T	n1qlToRawCustom(N1qlQuery query, Func1<TranscoderUtils.ByteBufToArray,T> deserializer) Synchronously perform a N1qlQuery and apply a user function to deserialize the raw N1QL response, which is represented as a TranscoderUtils.ByteBufToArray.
String	n1qlToRawJson(N1qlQuery query) Synchronously perform a N1qlQuery and return the raw N1QL response as a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RawQueryExecutor

public RawQueryExecutor(AsyncRawQueryExecutor async,
                        CouchbaseEnvironment env)

RawQueryExecutor

public RawQueryExecutor(String bucket,
                        String password,
                        ClusterFacade core,
                        CouchbaseEnvironment env)

Method Detail

n1qlToJsonObject

public JsonObject n1qlToJsonObject(N1qlQuery query)

Synchronously perform a N1qlQuery and return the raw N1QL response as a JsonObject.

Note that the query is executed “as is”, without any processing comparable to what is done in Bucket.query(N1qlQuery) (like enforcing a server side timeout or managing prepared statements).

Parameters:

query - the query to execute.

Returns:

the N1QL response as a JsonObject.

n1qlToRawJson

public String n1qlToRawJson(N1qlQuery query)

Synchronously perform a N1qlQuery and return the raw N1QL response as a String.

Note that the query is executed “as is”, without any processing comparable to what is done in Bucket.query(N1qlQuery) (like enforcing a server side timeout or managing prepared statements).

Parameters:

query - the query to execute.

Returns:

the N1QL response as a String.

n1qlToRawCustom

public <T> T n1qlToRawCustom(N1qlQuery query,
                             Func1<TranscoderUtils.ByteBufToArray,T> deserializer)

Synchronously perform a N1qlQuery and apply a user function to deserialize the raw N1QL response, which is represented as a TranscoderUtils.ByteBufToArray.

The array is derived from a ByteBuf that will be released, so it shouldn’t be used to back the returned instance. Its scope should be considered the scope of the call method.

Note that the query is executed “as is”, without any processing comparable to what is done in Bucket.query(N1qlQuery) (like enforcing a server side timeout or managing prepared statements).

Parameters:

query - the query to execute.

deserializer - a deserializer function that transforms the byte representation of the response into a custom type T.

T - the type of the response, once deserialized by the user-provided function.

Returns:

the N1QL response as a T.

ftsToJsonObject

public JsonObject ftsToJsonObject(SearchQuery query)

Synchronously perform a SearchQuery and return the raw N1QL response as a JsonObject.

Note that the query is executed “as is”, without any processing comparable to what is done in Bucket.query(SearchQuery) (like enforcing a server side timeout).

Parameters:

query - the query to execute.

Returns:

the FTS response as a JsonObject.

ftsToRawJson

public String ftsToRawJson(SearchQuery query)

Synchronously perform a SearchQuery and return the raw N1QL response as a String.

Note that the query is executed “as is”, without any processing comparable to what is done in Bucket.query(SearchQuery) (like enforcing a server side timeout).

Parameters:

query - the query to execute.

Returns:

the FTS response as a String.

ftsToRawCustom

public <T> T ftsToRawCustom(SearchQuery query,
                            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.

Note that the query is executed “as is”, without any processing comparable to what is done in Bucket.query(SearchQuery) (like enforcing a server side timeout).

Parameters:

query - the query to execute.

deserializer - a deserializer function that transforms the String representation of the response into a custom type T.

T - the type of the response, once deserialized by the user-provided function.

Returns:

the FTS response as a T.