org.jooq.ExecuteContext Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2014, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* This work is dual-licensed
* - under the Apache Software License 2.0 (the "ASL")
* - under the jOOQ License and Maintenance Agreement (the "jOOQ License")
* =============================================================================
* You may choose which license applies to you:
*
* - If you're using this work with Open Source databases, you may choose
* either ASL or jOOQ License.
* - If you're using this work with at least one commercial database, you must
* choose jOOQ License
*
* For more information, please visit http://www.jooq.org/licenses
*
* Apache Software License 2.0:
* -----------------------------------------------------------------------------
* 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.
*
* jOOQ License and Maintenance Agreement:
* -----------------------------------------------------------------------------
* Data Geekery grants the Customer the non-exclusive, timely limited and
* non-transferable license to install and use the Software under the terms of
* the jOOQ License and Maintenance Agreement.
*
* This library is distributed with a LIMITED WARRANTY. See the jOOQ License
* and Maintenance Agreement for more details: http://www.jooq.org/licensing
*/
package org.jooq;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.SQLWarning;
import org.jooq.conf.Settings;
import org.jooq.conf.StatementType;
import org.jooq.exception.DataAccessException;
/**
* A context object for {@link Query} execution passed to registered
* {@link ExecuteListener}'s.
*
* @author Lukas Eder
* @see ExecuteListener
*/
public interface ExecuteContext extends Scope {
/**
* The connection to be used in this execute context.
*
* This returns a proxy to the {@link Configuration#connectionProvider()}
* 's supplied connection. This proxy takes care of two things:
*
* - It takes care of properly implementing
* {@link Settings#getStatementType()}
* - It takes care of properly returning a connection to
* {@link ConnectionProvider#release(Connection)}, once jOOQ can release the
* connection
*
*/
Connection connection();
/**
* The type of database interaction that is being executed.
*
* @see ExecuteType
*/
ExecuteType type();
/**
* The jOOQ {@link Query} that is being executed or null if the
* query is unknown, if it is a batch query, or if there was no jOOQ
* Query.
*
* @see #routine()
* @see #batchQueries()
*/
Query query();
/**
* The jOOQ {@link Query} objects that are being executed in batch mode, or
* empty if the query is unknown or if there was no jOOQ Query.
*
* If a single Query is executed in non-batch mode, this will
* return an array of length 1, containing that
* Query
*
* @see #query()
* @see #routine()
* @return The executed Query object(s). This is never
* null
*/
Query[] batchQueries();
/**
* The jOOQ {@link Routine} that is being executed or null if
* the query is unknown or if there was no jOOQ Routine.
*
* @see #routine()
*/
Routine routine();
/**
* The SQL that is being executed or null if the SQL statement
* is unknown or if there was no SQL statement.
*/
String sql();
/**
* Override the SQL statement that is being executed.
*
* This may have no effect, if called at the wrong moment.
*
* @see ExecuteListener#renderEnd(ExecuteContext)
* @see ExecuteListener#prepareStart(ExecuteContext)
*/
void sql(String sql);
/**
* The generated SQL statements that are being executed in batch mode, or
* empty if the query is unknown or if there was no SQL statement.
*
* If a single Query is executed in non-batch mode, this will
* return an array of length 1, containing that
* Query
*
* @see #query()
* @see #routine()
* @return The generated SQL statement(s). This is never null
*/
String[] batchSQL();
/**
* Override the {@link Connection} that is being used for execution.
*
* This may have no effect, if called at the wrong moment.
*
* @see ExecuteListener#start(ExecuteContext)
*/
void connectionProvider(ConnectionProvider connectionProvider);
/**
* The {@link PreparedStatement} that is being executed or null
* if the statement is unknown or if there was no statement.
*
* This can be any of the following:
*
*
* - A
java.sql.PreparedStatement from your JDBC driver when
* a jOOQ Query is being executed as
* {@link StatementType#PREPARED_STATEMENT}
* - A
java.sql.Statement from your JDBC driver wrapped in a
* java.sql.PreparedStatement when your jOOQ Query
* is being executed as {@link StatementType#STATIC_STATEMENT}
* - A
java.sql.CallableStatement when you are executing a
* jOOQ Routine
*
*/
PreparedStatement statement();
/**
* Override the {@link PreparedStatement} that is being executed.
*
* This may have no effect, if called at the wrong moment.
*
* @see ExecuteListener#prepareEnd(ExecuteContext)
* @see ExecuteListener#bindStart(ExecuteContext)
*/
void statement(PreparedStatement statement);
/**
* The {@link ResultSet} that is being fetched or null if the
* result set is unknown or if no result set is being fetched.
*/
ResultSet resultSet();
/**
* Override the {@link ResultSet} that is being fetched.
*
* This may have no effect, if called at the wrong moment.
*
* @see ExecuteListener#executeEnd(ExecuteContext)
* @see ExecuteListener#fetchStart(ExecuteContext)
*/
void resultSet(ResultSet resultSet);
/**
* The last record that was fetched from the result set, or
* null if no record has been fetched.
*/
Record record();
/**
* Calling this has no effect. It is used by jOOQ internally.
*/
void record(Record record);
/**
* The number of rows that were affected by the last statement.
*
* This returns -1 if the number of affected rows is not yet
* available, or if affected rows are not applicable for the given
* statement.
*/
int rows();
/**
* Calling this has no effect. It is used by jOOQ internally.
*/
void rows(int rows);
/**
* The number of rows that were affected by the last statement executed in
* batch mode.
*
* If a single Query is executed in non-batch mode, this will
* return an array of length 1, containing {@link #rows()}
*
* This returns -1 values if the number of affected rows is not
* yet available, or if affected rows are not applicable for a given
* statement.
*
* @see #rows()
* @return The affected rows. This is never null
*/
int[] batchRows();
/**
* The last result that was fetched from the result set, or
* null if no result has been fetched.
*/
Result result();
/**
* Calling this has no effect. It is used by jOOQ internally.
*/
void result(Result result);
/**
* The {@link RuntimeException} being thrown.
*/
RuntimeException exception();
/**
* Override the {@link RuntimeException} being thrown.
*
* This may have no effect, if called at the wrong moment.
*/
void exception(RuntimeException e);
/**
* The {@link SQLException} that was thrown by the database.
*/
SQLException sqlException();
/**
* Override the {@link SQLException} being thrown.
*
* Any SQLException will be wrapped by jOOQ using an unchecked
* {@link DataAccessException}. To have jOOQ throw your own custom
* {@link RuntimeException}, use {@link #exception(RuntimeException)}
* instead. This may have no effect, if called at the wrong moment.
*/
void sqlException(SQLException e);
/**
* The {@link SQLWarning} that was emitted by the database.
*
* Note that fetching of warnings can be disabled using
* {@link Settings#isFetchWarnings()}, in case of which this property will
* be null.
*/
SQLWarning sqlWarning();
/**
* Override the {@link SQLWarning} being emitted.
*/
void sqlWarning(SQLWarning e);
}