Package com.couchbase.client.java.query

Class PrepareStatement

java.lang.Object

com.couchbase.client.java.query.PrepareStatement

All Implemented Interfaces:

SerializableStatement, Statement, Serializable

public class PrepareStatement
extends Object
implements SerializableStatement

A PREPARE Statement that wraps another Statement in order to send it to the server and produce a PreparedPayload.

Since:

2.1

Author:

Simon Baslé

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	PREPARE_PREFIX	a prefix to be used in order to prepare a named query plan for a statement

Method Summary

Modifier and Type	Method	Description
Statement	originalStatement()
static PrepareStatement	prepare(Statement statement)	Construct a PrepareStatement from a select-like Statement.
static PrepareStatement	prepare(Statement statement, String preparedName)	Construct a PrepareStatement from a select-like Statement and give it a name.
static PrepareStatement	prepare(String statement)	Construct a PrepareStatement from a statement in String format.
String	preparedName()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

PREPARE_PREFIX

public static final String PREPARE_PREFIX

a prefix to be used in order to prepare a named query plan for a statement

See Also:

Constant Field Values

Method Details

originalStatement

public Statement originalStatement()

preparedName

public String preparedName()

toString

public String toString()

Overrides:

toString in class Object

prepare

public static PrepareStatement prepare(Statement statement)

Construct a PrepareStatement from a select-like Statement. Note that passing a PrepareStatement will return it directly, whereas passing a PreparedPayload will reuse the PreparedPayload.preparedName().

Parameters:

statement - the Statement to prepare.

Returns:

the prepared statement.

Throws:

IllegalArgumentException - when statement cannot be prepared.

prepare

public static PrepareStatement prepare(Statement statement,
String preparedName)

Construct a PrepareStatement from a select-like Statement and give it a name. Note that passing a PrepareStatement or a PreparedPayload will reuse the original statement but use the given name.

Parameters:

statement - the Statement to prepare.

preparedName - the name to give to the prepared statement

Returns:

the prepared statement.

Throws:

IllegalArgumentException - when statement cannot be prepared.

prepare

public static PrepareStatement prepare(String statement)

Construct a PrepareStatement from a statement in String format. Statement shouldn't begin with "PREPARE", otherwise a syntax error may be returned by the server.

Parameters:

statement - the statement to prepare (not starting with "PREPARE").

Returns:

the prepared statement.

Throws:

NullPointerException - when statement is null.