org.jooq.MetaProvider Maven / Gradle / Ivy

Go to download
/*
 * 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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * Apache-2.0 and offer limited warranties, support, maintenance, and commercial
 * database integrations.
 *
 * For more information, please visit: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import java.sql.DatabaseMetaData;

import org.jetbrains.annotations.NotNull;

/**
 * An SPI that can produce dynamic catalog, schema, table meta data information.
 * 
 * The default implementation will produce information based on
 * {@link DatabaseMetaData} obtained from the enclosing
 * {@link Configuration#connectionProvider()}.
 *
 * @author Lukas Eder
 */
@FunctionalInterface
public interface MetaProvider {

    /**
     * Provide meta data information.
     */
    @NotNull
    Meta provide();
}