org.springframework.data.cassandra.core.ExecutableUpdateOperation Maven / Gradle / Ivy
Show all versions of spring-data-cassandra Show documentation
/*
* Copyright 2018-2020 the original author or authors.
*
* 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
*
* https://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 org.springframework.data.cassandra.core;
import org.springframework.data.cassandra.core.query.Query;
import org.springframework.data.cassandra.core.query.Update;
import org.springframework.util.Assert;
import com.datastax.oss.driver.api.core.CqlIdentifier;
/**
* {@link ExecutableUpdateOperation} allows creation and execution of Cassandra {@code UPDATE} operation in a fluent API
* style.
*
* The starting {@literal domainType} is used for mapping the {@link Query} provided via {@code matching}, as well as
* the {@link Update} provided via {@code apply} into the Cassandra specific representations. The table to operate on is
* by default derived from the initial {@literal domainType} and can be defined there via
* {@link org.springframework.data.cassandra.core.mapping.Table}. Using {@code inTable} allows the developer to override
* the table name for the execution.
*
*
*
* update(Jedi.class)
* .inTable("star_wars")
* .matching(query(where("firstname").is("luke")))
* .apply(update("lastname", "skywalker"))
* .all();
*
*
*
* @author Mark Paluch
* @author John Blum
* @see org.springframework.data.cassandra.core.ExecutableUpdateOperation
* @see org.springframework.data.cassandra.core.query.Query
* @see org.springframework.data.cassandra.core.query.Update
* @since 2.1
*/
public interface ExecutableUpdateOperation {
/**
* Begin creating an {@code UPDATE} operation for the given {@link Class domainType}.
*
* @param domainType {@link Class type} of domain object to update; must not be {@literal null}.
* @return new instance of {@link ExecutableUpdate}.
* @throws IllegalArgumentException if {@link Class domainType} is {@literal null}.
*/
ExecutableUpdate update(Class domainType);
/**
* Table override (optional).
*/
interface UpdateWithTable {
/**
* Explicitly set the {@link String name} of the table on which to execute the update.
*
* Skip this step to use the default table derived from the {@link Class domain type}.
*
* @param table {@link String name} of the table; must not be {@literal null} or empty.
* @return new instance of {@link UpdateWithQuery}.
* @throws IllegalArgumentException if {@link String table} is {@literal null} or empty.
* @see #inTable(CqlIdentifier)
* @see UpdateWithQuery
*/
default UpdateWithQuery inTable(String table) {
Assert.hasText(table, "Table name must not be null or empty");
return inTable(CqlIdentifier.fromCql(table));
}
/**
* Explicitly set the {@link CqlIdentifier name} of the table on which to execute the update.
*
* Skip this step to use the default table derived from the {@link Class domain type}.
*
* @param table {@link CqlIdentifier name} of the table; must not be {@literal null}.
* @return new instance of {@link UpdateWithQuery}.
* @throws IllegalArgumentException if {@link CqlIdentifier table} is {@literal null}.
* @see com.datastax.oss.driver.api.core.CqlIdentifier
* @see UpdateWithQuery
*/
UpdateWithQuery inTable(CqlIdentifier table);
}
/**
* Filtering (optional).
*/
interface UpdateWithQuery {
/**
* Filter rows with the given {@link Query}.
*
* @param query {@link Query} used to filter rows; must not be {@literal null}.
* @return new instance of {@link TerminatingUpdate}.
* @throws IllegalArgumentException if {@link Query} is {@literal null}.
* @see TerminatingUpdate
*/
TerminatingUpdate matching(Query query);
}
/**
* Set the {@link Update} to apply and execute the complete Cassandra {@link Update} statement.
*/
interface TerminatingUpdate {
/**
* Apply the given {@link Update} and execute the complete Cassandra {@link Update} statement.
*
* @param update {@link Update} to apply; must not be {@literal null}.
* @return the {@link WriteResult result} of the update; never {@literal null}.
* @throws IllegalArgumentException if {@link Update} is {@literal null}.
* @see org.springframework.data.cassandra.core.WriteResult
*/
WriteResult apply(Update update);
}
/**
* The {@link ExecutableUpdate} interface provides methods for constructing {@code UPDATE} operations in a fluent way.
*/
interface ExecutableUpdate extends UpdateWithTable, UpdateWithQuery {}
}