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.DatabaseMetaData;
022import java.sql.SQLException;
023
024/**
025 * Functional interface used by {@link Database#readDatabaseMetaData(DatabaseMetaDataReader)}, which permits callers to examine a transient {@link DatabaseMetaData} instance.
026 *
027 * @author <a href="https://www.revetkn.com">Mark Allen</a>
028 * @since 3.0.0
029 */
030@FunctionalInterface
031public interface DatabaseMetaDataReader {
032        /**
033         * Examines a JDBC {@link DatabaseMetaData}, which provides comprehensive vendor-specific information about this database as a whole.
034         *
035         * @param databaseMetaData JBDC metadata for this database
036         * @throws SQLException if an error occurs while examining metadata
037         */
038        void read(@NonNull DatabaseMetaData databaseMetaData) throws SQLException;
039}