com.datastax.oss.driver.api.core.cql

Class StatementBuilder<SelfT extends StatementBuilder<SelfT,StatementT>,StatementT extends Statement<StatementT>>

java.lang.Object

com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT,StatementT>

Direct Known Subclasses:

BatchStatementBuilder, BoundStatementBuilder, SimpleStatementBuilder

@NotThreadSafe
public abstract class StatementBuilder<SelfT extends StatementBuilder<SelfT,StatementT>,StatementT extends Statement<StatementT>>
extends Object

Handle options common to all statement builders.

See Also:

SimpleStatement.builder(String), BatchStatement.builder(BatchType), PreparedStatement.boundStatementBuilder(Object...)

Field Summary

Fields

Modifier and Type	Field and Description
protected ConsistencyLevel	consistencyLevel
protected DriverExecutionProfile	executionProfile
protected String	executionProfileName
protected Boolean	idempotent
protected Node	node
protected int	nowInSeconds
protected int	pageSize
protected ByteBuffer	pagingState
protected ByteBuffer	routingKey
protected CqlIdentifier	routingKeyspace
protected Token	routingToken
protected ConsistencyLevel	serialConsistencyLevel
protected Duration	timeout
protected long	timestamp
protected boolean	tracing

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StatementBuilder()
protected	StatementBuilder(StatementT template)

Method Summary

Modifier and Type	Method and Description
SelfT	addCustomPayload(String key, ByteBuffer value)
abstract StatementT	build()
protected Map<String,ByteBuffer>	buildCustomPayload()
SelfT	clearCustomPayload()
SelfT	disableTracing() Deprecated. this method only exists to ease the transition from driver 3, it is an alias for setTracing(false).
SelfT	enableTracing() Deprecated. this method only exists to ease the transition from driver 3, it is an alias for setTracing(true).
SelfT	setConsistencyLevel(ConsistencyLevel consistencyLevel)
SelfT	setDefaultTimestamp(long timestamp) Deprecated. this method only exists to ease the transition from driver 3, it is an alias for setQueryTimestamp(long).
SelfT	setExecutionProfile(DriverExecutionProfile executionProfile)
SelfT	setExecutionProfileName(String executionProfileName)
SelfT	setFetchSize(int pageSize) Deprecated. this method only exists to ease the transition from driver 3, it is an alias for setPageSize(int).
SelfT	setIdempotence(Boolean idempotent)
SelfT	setNode(Node node)
SelfT	setNowInSeconds(int nowInSeconds)
SelfT	setPageSize(int pageSize)
SelfT	setPagingState(ByteBuffer pagingState)
SelfT	setQueryTimestamp(long timestamp)
SelfT	setRoutingKey(ByteBuffer... newRoutingKeyComponents)
SelfT	setRoutingKey(ByteBuffer routingKey)
SelfT	setRoutingKeyspace(CqlIdentifier routingKeyspace)
SelfT	setRoutingKeyspace(String routingKeyspaceName) Shortcut for setRoutingKeyspace(CqlIdentifier.fromCql(routingKeyspaceName)).
SelfT	setRoutingToken(Token routingToken)
SelfT	setSerialConsistencyLevel(ConsistencyLevel serialConsistencyLevel)
SelfT	setTimeout(Duration timeout)
SelfT	setTracing() This method is a shortcut to setTracing(boolean) with an argument of true.
SelfT	setTracing(boolean tracing)

Methods inherited from class java.lang.Object

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

Field Detail

executionProfileName

@Nullable
protected String executionProfileName

executionProfile

@Nullable
protected DriverExecutionProfile executionProfile

routingKeyspace

@Nullable
protected CqlIdentifier routingKeyspace

routingKey

@Nullable
protected ByteBuffer routingKey

routingToken

@Nullable
protected Token routingToken

idempotent

@Nullable
protected Boolean idempotent

tracing

protected boolean tracing

timestamp

protected long timestamp

pagingState

@Nullable
protected ByteBuffer pagingState

pageSize

protected int pageSize

consistencyLevel

@Nullable
protected ConsistencyLevel consistencyLevel

serialConsistencyLevel

@Nullable
protected ConsistencyLevel serialConsistencyLevel

timeout

@Nullable
protected Duration timeout

node

@Nullable
protected Node node

nowInSeconds

protected int nowInSeconds

Constructor Detail

StatementBuilder

protected StatementBuilder()

StatementBuilder

protected StatementBuilder(StatementT template)

Method Detail

setExecutionProfileName

@NonNull
public SelfT setExecutionProfileName(@Nullable
                                              String executionProfileName)

See Also:

Statement.setExecutionProfileName(String)

setExecutionProfile

@NonNull
public SelfT setExecutionProfile(@Nullable
                                          DriverExecutionProfile executionProfile)

See Also:

Statement.setExecutionProfile(DriverExecutionProfile)

setRoutingKeyspace

@NonNull
public SelfT setRoutingKeyspace(@Nullable
                                         CqlIdentifier routingKeyspace)

See Also:

Statement.setRoutingKeyspace(CqlIdentifier)

setRoutingKeyspace

@NonNull
public SelfT setRoutingKeyspace(@Nullable
                                         String routingKeyspaceName)

Shortcut for setRoutingKeyspace(CqlIdentifier.fromCql(routingKeyspaceName)).

setRoutingKey

@NonNull
public SelfT setRoutingKey(@Nullable
                                    ByteBuffer routingKey)

See Also:

Statement.setRoutingKey(ByteBuffer)

setRoutingKey

@NonNull
public SelfT setRoutingKey(@NonNull
                                    ByteBuffer... newRoutingKeyComponents)

See Also:

Statement.setRoutingKey(ByteBuffer...)

setRoutingToken

@NonNull
public SelfT setRoutingToken(@Nullable
                                      Token routingToken)

See Also:

Statement.setRoutingToken(Token)

addCustomPayload

@NonNull
public SelfT addCustomPayload(@NonNull
                                       String key,
                                       @Nullable
                                       ByteBuffer value)

See Also:

Statement.setCustomPayload(Map)

clearCustomPayload

@NonNull
public SelfT clearCustomPayload()

See Also:

Statement.setCustomPayload(Map)

setIdempotence

@NonNull
public SelfT setIdempotence(@Nullable
                                     Boolean idempotent)

See Also:

Statement.setIdempotent(Boolean)

setTracing

@NonNull
public SelfT setTracing()

This method is a shortcut to setTracing(boolean) with an argument of true. It is preserved to maintain API compatibility.

See Also:

Statement.setTracing(boolean)

setTracing

@NonNull
public SelfT setTracing(boolean tracing)

See Also:

Statement.setTracing(boolean)

enableTracing

@Deprecated
 @NonNull
public SelfT enableTracing()

Deprecated. this method only exists to ease the transition from driver 3, it is an alias for setTracing(true).

disableTracing

@Deprecated
 @NonNull
public SelfT disableTracing()

Deprecated. this method only exists to ease the transition from driver 3, it is an alias for setTracing(false).

setQueryTimestamp

@NonNull
public SelfT setQueryTimestamp(long timestamp)

See Also:

Statement.setQueryTimestamp(long)

setDefaultTimestamp

@Deprecated
 @NonNull
public SelfT setDefaultTimestamp(long timestamp)

Deprecated. this method only exists to ease the transition from driver 3, it is an alias for setQueryTimestamp(long).

setPagingState

@NonNull
public SelfT setPagingState(@Nullable
                                     ByteBuffer pagingState)

See Also:

Statement.setPagingState(ByteBuffer)

setPageSize

@NonNull
public SelfT setPageSize(int pageSize)

See Also:

Statement.setPageSize(int)

setFetchSize

@Deprecated
 @NonNull
public SelfT setFetchSize(int pageSize)

Deprecated. this method only exists to ease the transition from driver 3, it is an alias for setPageSize(int).

setConsistencyLevel

@NonNull
public SelfT setConsistencyLevel(@Nullable
                                          ConsistencyLevel consistencyLevel)

See Also:

Statement.setConsistencyLevel(ConsistencyLevel)

setSerialConsistencyLevel

@NonNull
public SelfT setSerialConsistencyLevel(@Nullable
                                                ConsistencyLevel serialConsistencyLevel)

See Also:

Statement.setSerialConsistencyLevel(ConsistencyLevel)

setTimeout

@NonNull
public SelfT setTimeout(@Nullable
                                 Duration timeout)

See Also:

Statement.setTimeout(Duration)

setNode

public SelfT setNode(@Nullable
                     Node node)

See Also:

Statement.setNode(Node)

setNowInSeconds

public SelfT setNowInSeconds(int nowInSeconds)

See Also:

Statement.setNowInSeconds(int)

buildCustomPayload

@NonNull
protected Map<String,ByteBuffer> buildCustomPayload()

build

@NonNull
public abstract StatementT build()