org.firebirdsql.jdbc.metadata.GetFunctions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation
JDBC Driver for the Firebird RDBMS
The newest version!
/*
 * Firebird Open Source JDBC Driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a source control history command.
 *
 * All rights reserved.
 */
package org.firebirdsql.jdbc.metadata;

import org.firebirdsql.gds.ng.fields.RowDescriptor;
import org.firebirdsql.gds.ng.fields.RowValue;
import org.firebirdsql.jdbc.DbMetadataMediator;
import org.firebirdsql.jdbc.DbMetadataMediator.MetadataQuery;
import org.firebirdsql.util.FirebirdSupportInfo;
import org.firebirdsql.util.InternalApi;

import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;

import static java.sql.DatabaseMetaData.functionNoTable;
import static org.firebirdsql.gds.ISCConstants.SQL_SHORT;
import static org.firebirdsql.gds.ISCConstants.SQL_VARYING;
import static org.firebirdsql.jdbc.metadata.FbMetadataConstants.OBJECT_NAME_LENGTH;
import static org.firebirdsql.jdbc.metadata.NameHelper.toSpecificName;

/**
 * Provides the implementation for {@link java.sql.DatabaseMetaData#getFunctions(String, String, String)}.
 *
 * @author Mark Rotteveel
 * @since 4.0
 */
@InternalApi
public abstract class GetFunctions extends AbstractMetadataMethod {

    private static final String FUNCTIONS = "FUNCTIONS";
    private static final String COLUMN_FUNCTION_NAME = "RDB$FUNCTION_NAME";
    
    private static final RowDescriptor ROW_DESCRIPTOR = DbMetadataMediator.newRowDescriptorBuilder(11)
            .at(0).simple(SQL_VARYING | 1, OBJECT_NAME_LENGTH, "FUNCTION_CAT", FUNCTIONS).addField()
            .at(1).simple(SQL_VARYING | 1, OBJECT_NAME_LENGTH, "FUNCTION_SCHEM", FUNCTIONS).addField()
            .at(2).simple(SQL_VARYING, OBJECT_NAME_LENGTH, "FUNCTION_NAME", FUNCTIONS).addField()
            // Field in Firebird is actually a blob, using Integer.MAX_VALUE for length
            .at(3).simple(SQL_VARYING | 1, Integer.MAX_VALUE, "REMARKS", FUNCTIONS).addField()
            .at(4).simple(SQL_SHORT, 0, "FUNCTION_TYPE", FUNCTIONS).addField()
            // space for quoted package name, ".", quoted function name (assuming no double quotes in name)
            .at(5).simple(SQL_VARYING, 2 * OBJECT_NAME_LENGTH + 5, "SPECIFIC_NAME", FUNCTIONS).addField()
            // non-standard extensions
            .at(6).simple(SQL_VARYING | 1, Integer.MAX_VALUE, "JB_FUNCTION_SOURCE", FUNCTIONS).addField()
            .at(7).simple(SQL_VARYING, 4, "JB_FUNCTION_KIND", FUNCTIONS).addField()
            .at(8).simple(SQL_VARYING | 1, 255, "JB_MODULE_NAME", FUNCTIONS).addField()
            .at(9).simple(SQL_VARYING | 1, 255, "JB_ENTRYPOINT", FUNCTIONS).addField()
            .at(10).simple(SQL_VARYING | 1, 255, "JB_ENGINE_NAME", FUNCTIONS).addField()
            .toRowDescriptor();

    private GetFunctions(DbMetadataMediator mediator) {
        super(ROW_DESCRIPTOR, mediator);
    }

    /**
     * @see java.sql.DatabaseMetaData#getFunctions(String, String, String)
     */
    public final ResultSet getFunctions(String catalog, String functionNamePattern) throws SQLException {
        if ("".equals(functionNamePattern)) {
            // Matching function name not possible
            return createEmpty();
        }

        MetadataQuery metadataQuery = createGetFunctionsQuery(catalog, functionNamePattern);
        return createMetaDataResultSet(metadataQuery);
    }

    @Override
    final RowValue createMetadataRow(ResultSet rs, RowValueBuilder valueBuilder) throws SQLException {
        String catalog = rs.getString("FUNCTION_CAT");
        String functionName = rs.getString("FUNCTION_NAME");
        return valueBuilder
                .at(0).setString(catalog)
                .at(1).set(null)
                .at(2).setString(functionName)
                .at(3).setString(rs.getString("REMARKS"))
                .at(4).setShort(functionNoTable)
                .at(5).setString(toSpecificName(catalog, functionName))
                .at(6).setString(rs.getString("JB_FUNCTION_SOURCE"))
                .at(7).setString(rs.getString("JB_FUNCTION_KIND"))
                .at(8).setString(rs.getString("JB_MODULE_NAME"))
                .at(9).setString(rs.getString("JB_ENTRYPOINT"))
                .at(10).setString(rs.getString("JB_ENGINE_NAME"))
                .toRowValue(false);
    }

    abstract MetadataQuery createGetFunctionsQuery(String catalog, String functionNamePattern);

    /**
     * Creates an instance of {@code GetFunctions}.
     *
     * @param mediator
     *         Database metadata mediator
     * @return Instance
     */
    public static GetFunctions create(DbMetadataMediator mediator) {
        FirebirdSupportInfo firebirdSupportInfo = mediator.getFirebirdSupportInfo();
        // NOTE: Indirection through static method prevents unnecessary classloading
        if (firebirdSupportInfo.isVersionEqualOrAbove(3)) {
            if (mediator.isUseCatalogAsPackage()) {
                return FB3CatalogAsPackage.createInstance(mediator);
            }
            return FB3.createInstance(mediator);
        } else {
            return FB2_5.createInstance(mediator);
        }
    }

    /**
     * Implementation suitable for Firebird 2.5 and earlier.
     */
    @SuppressWarnings("java:S101")
    private static final class FB2_5 extends GetFunctions {

        private static final String GET_FUNCTIONS_FRAGMENT_2_5 = """
                select
                  null as FUNCTION_CAT,
                  RDB$FUNCTION_NAME as FUNCTION_NAME,
                  RDB$DESCRIPTION as REMARKS,
                  cast(null as blob sub_type text) as JB_FUNCTION_SOURCE,
                  'UDF' as JB_FUNCTION_KIND,
                  trim(trailing from RDB$MODULE_NAME) as JB_MODULE_NAME,
                  trim(trailing from RDB$ENTRYPOINT) as JB_ENTRYPOINT,
                  cast(null as varchar(255)) as JB_ENGINE_NAME
                from RDB$FUNCTIONS""";

        private static final String GET_FUNCTIONS_ORDER_BY_2_5 = "\norder by RDB$FUNCTION_NAME";


        private FB2_5(DbMetadataMediator mediator) {
            super(mediator);
        }

        private static GetFunctions createInstance(DbMetadataMediator mediator) {
            return new FB2_5(mediator);
        }

        @Override
        MetadataQuery createGetFunctionsQuery(String catalog, String functionNamePattern) {
            Clause functionNameClause = new Clause(COLUMN_FUNCTION_NAME, functionNamePattern);
            String queryText = GET_FUNCTIONS_FRAGMENT_2_5
                    + functionNameClause.getCondition("\nwhere ", "")
                    + GET_FUNCTIONS_ORDER_BY_2_5;
            return new MetadataQuery(queryText, Clause.parameters(functionNameClause));
        }
    }

    /**
     * Implementation suitable for Firebird 3 and higher; filters out functions in packages.
     */
    private static final class FB3 extends GetFunctions {

        private static final String GET_FUNCTIONS_FRAGMENT_3 = """
                select
                  null as FUNCTION_CAT,
                  trim(trailing from RDB$FUNCTION_NAME) as FUNCTION_NAME,
                  RDB$DESCRIPTION as REMARKS,
                  RDB$FUNCTION_SOURCE as JB_FUNCTION_SOURCE,
                  case
                    when RDB$LEGACY_FLAG = 1 then 'UDF'
                    when RDB$ENGINE_NAME is not null then 'UDR'
                    else 'PSQL'
                  end as JB_FUNCTION_KIND,
                  trim(trailing from RDB$MODULE_NAME) as JB_MODULE_NAME,
                  trim(trailing from RDB$ENTRYPOINT) as JB_ENTRYPOINT,
                  trim(trailing from RDB$ENGINE_NAME) as JB_ENGINE_NAME
                from RDB$FUNCTIONS
                where RDB$PACKAGE_NAME is null""";

        // NOTE: Including RDB$PACKAGE_NAME so index can be used to sort
        private static final String GET_FUNCTIONS_ORDER_BY_3 = "\norder by RDB$PACKAGE_NAME, RDB$FUNCTION_NAME";

        private FB3(DbMetadataMediator mediator) {
            super(mediator);
        }

        private static GetFunctions createInstance(DbMetadataMediator mediator) {
            return new FB3(mediator);
        }

        @Override
        MetadataQuery createGetFunctionsQuery(String catalog, String functionNamePattern) {
            Clause functionNameClause = new Clause(COLUMN_FUNCTION_NAME, functionNamePattern);
            String queryText = GET_FUNCTIONS_FRAGMENT_3
                    + functionNameClause.getCondition("\nand ", "")
                    + GET_FUNCTIONS_ORDER_BY_3;
            return new MetadataQuery(queryText, Clause.parameters(functionNameClause));
        }
    }

    private static final class FB3CatalogAsPackage extends GetFunctions {

        private static final String GET_FUNCTIONS_FRAGMENT_3_W_PKG = """
                select
                  coalesce(trim(trailing from RDB$PACKAGE_NAME), '') as FUNCTION_CAT,
                  trim(trailing from RDB$FUNCTION_NAME) as FUNCTION_NAME,
                  RDB$DESCRIPTION as REMARKS,
                  RDB$FUNCTION_SOURCE as JB_FUNCTION_SOURCE,
                  case
                    when RDB$LEGACY_FLAG = 1 then 'UDF'
                    when RDB$ENGINE_NAME is not null then 'UDR'
                    else 'PSQL'
                  end as JB_FUNCTION_KIND,
                  trim(trailing from RDB$MODULE_NAME) as JB_MODULE_NAME,
                  trim(trailing from RDB$ENTRYPOINT) as JB_ENTRYPOINT,
                  trim(trailing from RDB$ENGINE_NAME) as JB_ENGINE_NAME
                from RDB$FUNCTIONS""";

        private static final String GET_FUNCTIONS_ORDER_BY_3_W_PKG =
                "\norder by RDB$PACKAGE_NAME nulls first, RDB$FUNCTION_NAME";
        
        private static final String COLUMN_CATALOG_NAME = "RDB$PACKAGE_NAME";

        private FB3CatalogAsPackage(DbMetadataMediator mediator) {
            super(mediator);
        }

        private static GetFunctions createInstance(DbMetadataMediator mediator) {
            return new FB3CatalogAsPackage(mediator);
        }

        @Override
        MetadataQuery createGetFunctionsQuery(String catalog, String functionNamePattern) {
            var clauses = new ArrayList(2);
            if (catalog != null) {
                // To quote from the JDBC API: "" retrieves those without a catalog; null means that the catalog name
                // should not be used to narrow the search
                if (catalog.isEmpty()) {
                    clauses.add(Clause.isNullClause(COLUMN_CATALOG_NAME));
                } else {
                    // Exact matches only
                    clauses.add(Clause.equalsClause(COLUMN_CATALOG_NAME, catalog));
                }
            }
            clauses.add(new Clause(COLUMN_FUNCTION_NAME, functionNamePattern));
            //@formatter:off
            String sql = GET_FUNCTIONS_FRAGMENT_3_W_PKG
                    + (Clause.anyCondition(clauses)
                    ? "\nwhere " + Clause.conjunction(clauses)
                    : "")
                    + GET_FUNCTIONS_ORDER_BY_3_W_PKG;
            //@formatter:on
            return new MetadataQuery(sql, Clause.parameters(clauses));
        }
    }
}