com.datastax.oss.driver.api.querybuilder.condition.ConditionalStatement Maven / Gradle / Ivy
/*
* Copyright DataStax, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.datastax.oss.driver.api.querybuilder.condition;
import com.datastax.oss.driver.api.core.CqlIdentifier;
import com.datastax.oss.driver.api.querybuilder.QueryBuilder;
import com.datastax.oss.driver.api.querybuilder.term.Term;
import com.datastax.oss.driver.internal.querybuilder.condition.DefaultConditionBuilder;
import com.datastax.oss.driver.internal.querybuilder.lhs.ColumnComponentLeftOperand;
import com.datastax.oss.driver.internal.querybuilder.lhs.ColumnLeftOperand;
import com.datastax.oss.driver.internal.querybuilder.lhs.FieldLeftOperand;
import edu.umd.cs.findbugs.annotations.CheckReturnValue;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Arrays;
/**
* 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.
*/
public interface ConditionalStatement> {
/**
* Adds an IF EXISTS condition.
*
* If any column conditions were added before, they will be cleared.
*/
@NonNull
@CheckReturnValue
SelfT ifExists();
/**
* Adds an IF condition. All conditions are logically joined with AND. If {@link #ifExists()} was
* invoked on this statement before, it will get cancelled.
*
*
To create the argument, use one of the factory methods in {@link Condition}, for example
* {@link Condition#column(CqlIdentifier) column}.
*
*
If you add multiple conditions as once, consider {@link #if_(Iterable)} as a more efficient
* alternative.
*/
@NonNull
@CheckReturnValue
SelfT if_(@NonNull Condition condition);
/**
* Adds multiple IF conditions at once. All conditions are logically joined with AND. If {@link
* #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 {@link Condition}, for example
* {@link Condition#column(CqlIdentifier) column}.
*/
@NonNull
@CheckReturnValue
SelfT if_(@NonNull Iterable conditions);
/** Var-arg equivalent of {@link #if_(Iterable)}. */
@NonNull
@CheckReturnValue
default SelfT if_(@NonNull Condition... conditions) {
return if_(Arrays.asList(conditions));
}
/**
* Adds an IF condition on a simple column, as in {@code DELETE... IF k=1}.
*
* This is the equivalent of creating a condition with {@link Condition#column(CqlIdentifier)}
* and passing it to {@link #if_(Condition)}.
*/
@NonNull
default ConditionBuilder ifColumn(@NonNull CqlIdentifier columnId) {
return new DefaultConditionBuilder.Fluent<>(this, new ColumnLeftOperand(columnId));
}
/**
* Shortcut for {@link #ifColumn(CqlIdentifier) column(CqlIdentifier.fromCql(columnName))}.
*
* This is the equivalent of creating a condition with {@link Condition#column(String)} and
* passing it to {@link #if_(Condition)}.
*/
@NonNull
default ConditionBuilder ifColumn(@NonNull String columnName) {
return ifColumn(CqlIdentifier.fromCql(columnName));
}
/**
* Adds an IF condition on a field in a UDT column for a conditional statement, as in {@code
* DELETE... IF address.street='test'}.
*
* This is the equivalent of creating a condition with {@link Condition#field(CqlIdentifier,
* CqlIdentifier)} and passing it to {@link #if_(Condition)}.
*/
@NonNull
default ConditionBuilder ifField(
@NonNull CqlIdentifier columnId, @NonNull CqlIdentifier fieldId) {
return new DefaultConditionBuilder.Fluent<>(this, new FieldLeftOperand(columnId, fieldId));
}
/**
* Shortcut for {@link #ifField(CqlIdentifier, CqlIdentifier)
* field(CqlIdentifier.fromCql(columnName), CqlIdentifier.fromCql(fieldName))}.
*
* This is the equivalent of creating a condition with {@link Condition#field(String, String)}
* and passing it to {@link #if_(Condition)}.
*/
@NonNull
default ConditionBuilder ifField(@NonNull String columnName, @NonNull String fieldName) {
return ifField(CqlIdentifier.fromCql(columnName), CqlIdentifier.fromCql(fieldName));
}
/**
* Adds an IF condition on an element in a collection column for a conditional statement, as in
* {@code DELETE... IF m[0]=1}.
*
* This is the equivalent of creating a condition with {@link Condition#element(CqlIdentifier,
* Term)} and passing it to {@link #if_(Condition)}.
*/
@NonNull
default ConditionBuilder ifElement(@NonNull CqlIdentifier columnId, @NonNull Term index) {
return new DefaultConditionBuilder.Fluent<>(
this, new ColumnComponentLeftOperand(columnId, index));
}
/**
* Shortcut for {@link #ifElement(CqlIdentifier, Term) element(CqlIdentifier.fromCql(columnName),
* index)}.
*
* This is the equivalent of creating a condition with {@link Condition#element(String, Term)}
* and passing it to {@link #if_(Condition)}.
*/
@NonNull
default ConditionBuilder ifElement(@NonNull String columnName, @NonNull Term index) {
return ifElement(CqlIdentifier.fromCql(columnName), index);
}
/**
* Adds a raw CQL snippet as a condition.
*
* This is the equivalent of creating a condition with {@link QueryBuilder#raw(String)} and
* passing it to {@link #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 QueryBuilder#raw(String)
*/
@NonNull
@CheckReturnValue
default SelfT ifRaw(@NonNull String raw) {
return if_(QueryBuilder.raw(raw));
}
}