org.springframework.data.cassandra.core.cql.PreparedStatementCreator Maven / Gradle / Ivy
Show all versions of spring-data-cassandra Show documentation
/*
* Copyright 2013-2021 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.cql;
import com.datastax.oss.driver.api.core.CqlSession;
import com.datastax.oss.driver.api.core.DriverException;
import com.datastax.oss.driver.api.core.cql.PreparedStatement;
/**
* One of the two central callback interfaces used by the {@link CqlTemplate} class. This interface creates a
* {@link PreparedStatement} given a session, provided by the {@link CqlTemplate} class. Implementations are responsible
* for providing CQL and any necessary parameters.
*
* Implementations do not need to concern themselves with {@link DriverException}s that may be thrown from
* operations they attempt. The {@link CqlTemplate} class will catch and handle {@link DriverException}s appropriately.
*
* Classes implementing this interface should also implement the {@link CqlProvider} interface if it is able to provide
* the CQL it uses for {@link PreparedStatement} creation. This allows for better contextual information in case of
* exceptions.
*
* @author David Webb
* @author Mark Paluch
* @see CqlTemplate#execute(PreparedStatementCreator, PreparedStatementCallback)
* @see CqlTemplate#query(PreparedStatementCreator, RowCallbackHandler)
* @see CqlProvider
*/
@FunctionalInterface
public interface PreparedStatementCreator {
/**
* Create a statement in this session. Allows implementations to use {@link PreparedStatement}.
*
* @param session {@link CqlSession} to use to create statement.
* @return a prepared statement.
* @throws DriverException there is no need to catch {@link DriverException} that may be thrown in the implementation
* of this method. The {@link CqlTemplate} class will handle them.
*/
PreparedStatement createPreparedStatement(CqlSession session) throws DriverException;
}