com.datastax.oss.driver.api.querybuilder.condition

Interface ConditionalStatement<SelfT extends ConditionalStatement<SelfT>>

All Known Subinterfaces:

Delete, Update

public interface ConditionalStatement<SelfT extends ConditionalStatement<SelfT>>

A statement that can be applied conditionally, such as UPDATE or DELETE.

Not that this does not covert INSERT... IF NOT EXISTS, which is handled separately.

Method Summary

Modifier and Type	Method and Description
default SelfT	if_(Condition... conditions) Var-arg equivalent of if_(Iterable).
SelfT	if_(Condition condition) Adds an IF condition.
SelfT	if_(Iterable<Condition> conditions) Adds multiple IF conditions at once.
default ConditionBuilder<SelfT>	ifColumn(CqlIdentifier columnId) Adds an IF condition on a simple column, as in {@code DELETE...
default ConditionBuilder<SelfT>	ifColumn(String columnName) Shortcut for column(CqlIdentifier.fromCql(columnName)).
default ConditionBuilder<SelfT>	ifElement(CqlIdentifier columnId, Term index) Adds an IF condition on an element in a collection column for a conditional statement, as in {@code DELETE...
default ConditionBuilder<SelfT>	ifElement(String columnName, Term index) Shortcut for element(CqlIdentifier.fromCql(columnName), index).
SelfT	ifExists() Adds an IF EXISTS condition.
default ConditionBuilder<SelfT>	ifField(CqlIdentifier columnId, CqlIdentifier fieldId) Adds an IF condition on a field in a UDT column for a conditional statement, as in {@code DELETE...
default ConditionBuilder<SelfT>	ifField(String columnName, String fieldName) Shortcut for field(CqlIdentifier.fromCql(columnName), CqlIdentifier.fromCql(fieldName)).
default SelfT	ifRaw(String raw) Adds a raw CQL snippet as a condition.

Method Detail

ifExists

@NonNull
 @CheckReturnValue
SelfT ifExists()

Adds an IF EXISTS condition.

If any column conditions were added before, they will be cleared.

if_

@NonNull
 @CheckReturnValue
SelfT if_(@NonNull
                                      Condition condition)

Adds an IF condition. All conditions are logically joined with AND. If ifExists() was invoked on this statement before, it will get cancelled.

To create the argument, use one of the factory methods in Condition, for example column.

If you add multiple conditions as once, consider if_(Iterable) as a more efficient alternative.

if_

@NonNull
 @CheckReturnValue
SelfT if_(@NonNull
                                      Iterable<Condition> conditions)

Adds multiple IF conditions at once. All conditions are logically joined with AND. If ifExists() was invoked on this statement before, it will get cancelled.

This is slightly more efficient than adding the relations one by one (since the underlying implementation of this object is immutable).

To create the arguments, use one of the factory methods in Condition, for example column.

if_

@NonNull
 @CheckReturnValue
default SelfT if_(@NonNull
                                              Condition... conditions)

Var-arg equivalent of if_(Iterable).

ifColumn

@NonNull
default ConditionBuilder<SelfT> ifColumn(@NonNull
                                                  CqlIdentifier columnId)

Adds an IF condition on a simple column, as in DELETE... IF k=1.

This is the equivalent of creating a condition with Condition.column(CqlIdentifier) and passing it to if_(Condition).

ifColumn

@NonNull
default ConditionBuilder<SelfT> ifColumn(@NonNull
                                                  String columnName)

Shortcut for column(CqlIdentifier.fromCql(columnName)).

This is the equivalent of creating a condition with Condition.column(String) and passing it to if_(Condition).

ifField

@NonNull
default ConditionBuilder<SelfT> ifField(@NonNull
                                                 CqlIdentifier columnId,
                                                 @NonNull
                                                 CqlIdentifier fieldId)

Adds an IF condition on a field in a UDT column for a conditional statement, as in DELETE... IF address.street='test'.

This is the equivalent of creating a condition with Condition.field(CqlIdentifier, CqlIdentifier) and passing it to if_(Condition).

ifField

@NonNull
default ConditionBuilder<SelfT> ifField(@NonNull
                                                 String columnName,
                                                 @NonNull
                                                 String fieldName)

Shortcut for field(CqlIdentifier.fromCql(columnName), CqlIdentifier.fromCql(fieldName)).

This is the equivalent of creating a condition with Condition.field(String, String) and passing it to if_(Condition).

ifElement

@NonNull
default ConditionBuilder<SelfT> ifElement(@NonNull
                                                   CqlIdentifier columnId,
                                                   @NonNull
                                                   Term index)

Adds an IF condition on an element in a collection column for a conditional statement, as in DELETE... IF m[0]=1.

This is the equivalent of creating a condition with Condition.element(CqlIdentifier, Term) and passing it to if_(Condition).

ifElement

@NonNull
default ConditionBuilder<SelfT> ifElement(@NonNull
                                                   String columnName,
                                                   @NonNull
                                                   Term index)

Shortcut for element(CqlIdentifier.fromCql(columnName), index).

This is the equivalent of creating a condition with Condition.element(String, Term) and passing it to if_(Condition).

ifRaw

@NonNull
 @CheckReturnValue
default SelfT ifRaw(@NonNull
                                                String raw)

Adds a raw CQL snippet as a condition.

This is the equivalent of creating a condition with QueryBuilder.raw(String) and passing it to if_(Condition).

The contents will be appended to the query as-is, without any syntax checking or escaping. This method should be used with caution, as it's possible to generate invalid CQL that will fail at execution time; on the other hand, it can be used as a workaround to handle new CQL features that are not yet covered by the query builder.

See Also:

QueryBuilder.raw(String)