com.datastax.oss.driver.api.mapper.annotations

Annotation Type StatementAttributes

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface StatementAttributes

A set of compile time parameters to use for mapped queries (this can be used for methods annotated with Delete, Insert, Query, Select or Update).

If you decorate a DAO method with this, it will use those values when constructing the bound statement. Note that the method can also take a function argument to modify the statement at runtime; in that case, the values from this annotation will be applied first, and the function second.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	consistencyLevel The consistency level to use for the statement.
String	executionProfileName The name of the execution profile to use.
boolean[]	idempotence Whether the request is idempotent; that is, whether applying the request twice leaves the database in the same state.
int	pageSize The page size to use.
String	routingKeyspace The keyspace to use for token-aware routing.
String	serialConsistencyLevel The serial consistency level to use for the statement.
String	timeout How long to wait for this request to complete.

Element Detail

executionProfileName

public abstract String executionProfileName

The name of the execution profile to use.

See Also:

Statement.setExecutionProfileName(String)

Default:

""

pageSize

public abstract int pageSize

The page size to use.

If unset, the mapper won't set any value on the statement (letting it default to the value defined in the configuration).

See Also:

Statement.setPageSize(int)

Default:

-2147483648

idempotence

public abstract boolean[] idempotence

Whether the request is idempotent; that is, whether applying the request twice leaves the database in the same state.

If unset, the mapper won't set any value on the statement (letting it default to the value * defined in the configuration).

Note that this attribute is an array only to allow an empty default; only the first element will be considered.

See Also:

Statement.setIdempotent(Boolean)

Default:

{}

consistencyLevel

public abstract String consistencyLevel

The consistency level to use for the statement.

If unset, the mapper won't set any value on the statement (letting it default to the value defined in the configuration).

See Also:

Statement.setConsistencyLevel(ConsistencyLevel)

Default:

""

serialConsistencyLevel

public abstract String serialConsistencyLevel

The serial consistency level to use for the statement.

If unset, the mapper won't set any value on the statement (letting it default to the value defined in the configuration).

See Also:

Statement.setSerialConsistencyLevel(ConsistencyLevel)

Default:

""

timeout

public abstract String timeout

How long to wait for this request to complete.

This expects a string in the format accepted by Duration.parse(CharSequence).

If unset, the mapper won't set any value on the statement (letting it default to the value defined in the configuration).

See Also:

Statement.setTimeout(Duration)

Default:

""

routingKeyspace

public abstract String routingKeyspace

The keyspace to use for token-aware routing.

If unset, the mapper won't set any value on the statement.

See Also:

Statement.setRoutingKeyspace(String)

Default:

""