diff --git a/jOOQ/src/main/java/org/jooq/CloseableQuery.java b/jOOQ/src/main/java/org/jooq/CloseableQuery.java new file mode 100644 index 0000000000..bcbf291453 --- /dev/null +++ b/jOOQ/src/main/java/org/jooq/CloseableQuery.java @@ -0,0 +1,103 @@ +/* + * 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. + * + * Other licenses: + * ----------------------------------------------------------------------------- + * Commercial licenses for this work are available. These replace the above + * ASL 2.0 and offer limited warranties, support, maintenance, and commercial + * database integrations. + * + * For more information, please visit: http://www.jooq.org/licenses + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + */ + +package org.jooq; + +import java.sql.PreparedStatement; +import java.util.concurrent.CompletionStage; +import java.util.concurrent.Executor; + +import org.jooq.conf.StatementType; +import org.jooq.exception.DataAccessException; +import org.jooq.exception.DataTypeException; +import org.jooq.impl.DSL; + +import org.jetbrains.annotations.Blocking; +import org.jetbrains.annotations.NotNull; + +/** + * A {@link Query} that holds a reference to the underlying + * {@link PreparedStatement} without closing it, for reuse. + *

+ * It was created via {@link Query#keepStatement(boolean)} and must be treated + * as a resource, e.g. in a try-with-resources statement. + * + * @author Lukas Eder + */ +public interface CloseableQuery extends Query, AutoCloseable { + + @Override + @NotNull + CloseableQuery bind(String param, Object value) throws IllegalArgumentException, DataTypeException; + + @Override + @NotNull + CloseableQuery bind(int index, Object value) throws IllegalArgumentException, DataTypeException; + + // ------------------------------------------------------------------------ + // JDBC methods + // ------------------------------------------------------------------------ + + @Override + @NotNull + CloseableQuery poolable(boolean poolable); + + @Override + @NotNull + CloseableQuery queryTimeout(int seconds); + + @Override + @NotNull + CloseableQuery keepStatement(boolean keepStatement); + + /** + * Close the underlying statement. + *

+ * This closes the query's underlying {@link Statement} or + * {@link PreparedStatement} if a previous call to + * {@link #keepStatement(boolean)} indicated that jOOQ should keep + * statements open after query execution. If there is no underlying open + * statement, this call is simply ignored. + * + * @throws DataAccessException If something went wrong closing the statement + * @see java.sql.Statement#close() + */ + @Override + void close() throws DataAccessException; + +} diff --git a/jOOQ/src/main/java/org/jooq/CloseableResultQuery.java b/jOOQ/src/main/java/org/jooq/CloseableResultQuery.java new file mode 100644 index 0000000000..8ec464b599 --- /dev/null +++ b/jOOQ/src/main/java/org/jooq/CloseableResultQuery.java @@ -0,0 +1,243 @@ +/* + * 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. + * + * Other licenses: + * ----------------------------------------------------------------------------- + * Commercial licenses for this work are available. These replace the above + * ASL 2.0 and offer limited warranties, support, maintenance, and commercial + * database integrations. + * + * For more information, please visit: http://www.jooq.org/licenses + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + */ + +package org.jooq; + +import java.sql.PreparedStatement; +import java.util.Collection; + +import org.jooq.exception.DataTypeException; + +import org.jetbrains.annotations.NotNull; + +/** + * A {@link ResultQuery} that holds a reference to the underlying + * {@link PreparedStatement} without closing it, for reuse. + *

+ * It was created via {@link ResultQuery#keepStatement(boolean)} and must be + * treated as a resource, e.g. in a try-with-resources statement. + * + * @author Lukas Eder + */ +public interface CloseableResultQuery extends ResultQuery, CloseableQuery { + + @NotNull + @Override + CloseableResultQuery bind(String param, Object value) throws IllegalArgumentException, DataTypeException; + + @NotNull + @Override + CloseableResultQuery bind(int index, Object value) throws IllegalArgumentException, DataTypeException; + + // ------------------------------------------------------------------------ + // JDBC methods + // ------------------------------------------------------------------------ + + @NotNull + @Override + CloseableResultQuery poolable(boolean poolable); + + @NotNull + @Override + CloseableResultQuery queryTimeout(int timeout); + + @NotNull + @Override + CloseableResultQuery keepStatement(boolean keepStatement); + + @Override + @NotNull + CloseableResultQuery maxRows(int rows); + + @Override + @NotNull + CloseableResultQuery fetchSize(int rows); + + @Override + @NotNull + CloseableResultQuery resultSetConcurrency(int resultSetConcurrency); + + @Override + @NotNull + CloseableResultQuery resultSetType(int resultSetType); + + @Override + @NotNull + CloseableResultQuery resultSetHoldability(int resultSetHoldability); + + /** + * @deprecated - 3.10 - [#6254] - This functionality is no longer supported + * and will be removed in 4.0 + */ + @Override + @NotNull + @Deprecated(forRemoval = true, since = "3.10") + CloseableResultQuery intern(Field... fields); + + /** + * @deprecated - 3.10 - [#6254] - This functionality is no longer supported + * and will be removed in 4.0 + */ + @Override + @NotNull + @Deprecated(forRemoval = true, since = "3.10") + CloseableResultQuery intern(int... fieldIndexes); + + /** + * @deprecated - 3.10 - [#6254] - This functionality is no longer supported + * and will be removed in 4.0 + */ + @Override + @NotNull + @Deprecated(forRemoval = true, since = "3.10") + CloseableResultQuery intern(String... fieldNames); + + /** + * @deprecated - 3.10 - [#6254] - This functionality is no longer supported + * and will be removed in 4.0 + */ + @Override + @NotNull + @Deprecated(forRemoval = true, since = "3.10") + CloseableResultQuery intern(Name... fieldNames); + + @Override + @NotNull + CloseableResultQuery coerce(Table table); + + @Override + @NotNull + CloseableResultQuery coerce(Field... fields); + + @Override + @NotNull + CloseableResultQuery coerce(Collection> fields); + + + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15, Field field16); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15, Field field16, Field field17); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15, Field field16, Field field17, Field field18); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15, Field field16, Field field17, Field field18, Field field19); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15, Field field16, Field field17, Field field18, Field field19, Field field20); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15, Field field16, Field field17, Field field18, Field field19, Field field20, Field field21); + + @NotNull + @Override + CloseableResultQuery> coerce(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15, Field field16, Field field17, Field field18, Field field19, Field field20, Field field21, Field field22); + + + +}