001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.pyranid;
018
019import org.jspecify.annotations.NonNull;
020
021import java.sql.Connection;
022import java.util.Optional;
023
024/**
025 * Performs raw JDBC work with a {@link Connection} managed by {@link Database#useRawConnection(RawConnectionOperation)}.
026 * <p>
027 * The connection is valid only for the duration of the callback. Do not close it, retain it, manage transaction lifecycle
028 * directly from it, or mutate connection-wide state such as schema, catalog, client info, holdability, type map, or network
029 * timeout. Pyranid guards those operations and routes {@link java.sql.Statement#getConnection()} and
030 * {@link java.sql.DatabaseMetaData#getConnection()} back to the managed handle. {@link java.sql.ResultSet#getStatement()}
031 * returns a guarded statement, and guarded JDBC objects refuse driver-specific {@code unwrap(...)} calls that could expose
032 * the driver's underlying connection.
033 *
034 * @author <a href="https://www.revetkn.com">Mark Allen</a>
035 * @since 4.2.0
036 */
037@FunctionalInterface
038public interface RawConnectionOperation<T> {
039        /**
040         * Performs raw JDBC work with the provided connection.
041         *
042         * @param connection connection to use
043         * @return the operation result
044         * @throws Exception if the operation fails
045         */
046        @NonNull
047        Optional<T> perform(@NonNull Connection connection) throws Exception;
048}