#882 Schema support for getBestRowIdentifier

Author: mrotteveel

src/main/org/firebirdsql/jdbc/FBDatabaseMetaData.java

@@ -1372,14 +1372,19 @@ public ResultSet getTablePrivileges(String catalog, String schemaPattern, String
     /**
      * {@inheritDoc}
      * <p>
-     * Jaybird considers the primary key (scoped as {@code bestRowSession} as the best identifier for all scopes.
-     * Pseudo column {@code RDB$DB_KEY} (scoped as {@code bestRowTransaction} is considered the second-best alternative
+     * Jaybird considers the primary key (scoped as {@code bestRowSession}) as the best identifier for all scopes.
+     * Pseudo column {@code RDB$DB_KEY} (scoped as {@code bestRowTransaction}) is considered the second-best alternative
      * for scopes {@code bestRowTemporary} and {@code bestRowTransaction} if {@code table} has no primary key.
      * </p>
      * <p>
      * Jaybird currently considers {@code RDB$DB_KEY} to be {@link DatabaseMetaData#bestRowTransaction} even if the
      * dbkey_scope is set to 1 (session). This may change in the future. See also {@link #getRowIdLifetime()}.
      * </p>
+     * <p>
+     * On Firebird 6.0 and higher, passing {@code null} for {@code schema} will return columns of <strong>all</strong>
+     * tables with name {@code name}. It is recommended to <em>always</em> specify a non-{@code null} {@code schema} on
+     * Firebird 6.0 and higher.
+     * </p>
      */
     @Override
     public ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)

src/main/org/firebirdsql/jdbc/FBRowUpdater.java

@@ -1,5 +1,5 @@
 // SPDX-FileCopyrightText: Copyright 2005-2011 Roman Rokytskyy
-// SPDX-FileCopyrightText: Copyright 2012-2024 Mark Rotteveel
+// SPDX-FileCopyrightText: Copyright 2012-2025 Mark Rotteveel
 // SPDX-License-Identifier: LGPL-2.1-or-later
 package org.firebirdsql.jdbc;
 
@@ -250,8 +250,9 @@ private static List<FieldDescriptor> deriveKeyColumns(String tableName, RowDescr
      */
     private static List<FieldDescriptor> keyColumnsOfBestRowIdentifier(String tableName, RowDescriptor rowDescriptor,
             DatabaseMetaData dbmd) throws SQLException {
+        // TODO Add schema support
         try (ResultSet bestRowIdentifier = dbmd
-                .getBestRowIdentifier("", "", tableName, DatabaseMetaData.bestRowTransaction, true)) {
+                .getBestRowIdentifier("", null, tableName, DatabaseMetaData.bestRowTransaction, true)) {
             int bestRowIdentifierColumnCount = 0;
             List<FieldDescriptor> keyColumns = new ArrayList<>();
             while (bestRowIdentifier.next()) {

src/main/org/firebirdsql/jdbc/metadata/GetBestRowIdentifier.java

@@ -1,5 +1,5 @@
-// SPDX-FileCopyrightText: Copyright 2001-2024 Firebird development team and individual contributors
-// SPDX-FileCopyrightText: Copyright 2022-2024 Mark Rotteveel
+// SPDX-FileCopyrightText: Copyright 2001-2025 Firebird development team and individual contributors
+// SPDX-FileCopyrightText: Copyright 2022-2025 Mark Rotteveel
 // SPDX-License-Identifier: LGPL-2.1-or-later
 package org.firebirdsql.jdbc.metadata;
 
@@ -41,7 +41,7 @@
  * @author Mark Rotteveel
  * @since 5
  */
-public final class GetBestRowIdentifier extends AbstractMetadataMethod {
+public abstract class GetBestRowIdentifier extends AbstractMetadataMethod {
 
     private static final String ROWIDENTIFIER = "ROWIDENTIFIER";
 
@@ -56,31 +56,6 @@ public final class GetBestRowIdentifier extends AbstractMetadataMethod {
             .at(7).simple(SQL_SHORT, 0, "PSEUDO_COLUMN", ROWIDENTIFIER).addField()
             .toRowDescriptor();
 
-    //@formatter:off
-    private static final String GET_BEST_ROW_IDENT_START =
-            "select\n"
-            + "  RF.RDB$FIELD_NAME as COLUMN_NAME,\n"
-            + "  F.RDB$FIELD_TYPE as " + FIELD_TYPE + ",\n"
-            + "  F.RDB$FIELD_SUB_TYPE as " + FIELD_SUB_TYPE + ",\n"
-            + "  F.RDB$FIELD_PRECISION as " + FIELD_PRECISION + ",\n"
-            + "  F.RDB$FIELD_SCALE as " + FIELD_SCALE + ",\n"
-            + "  F.RDB$FIELD_LENGTH as " + FIELD_LENGTH + ",\n"
-            + "  F.RDB$CHARACTER_LENGTH as " + CHAR_LEN + ",\n"
-            + "  F.RDB$CHARACTER_SET_ID as " + CHARSET_ID + "\n"
-            + "from RDB$RELATION_CONSTRAINTS RC\n"
-            + "inner join RDB$INDEX_SEGMENTS IDX\n"
-            + "  on IDX.RDB$INDEX_NAME = RC.RDB$INDEX_NAME\n"
-            + "inner join RDB$RELATION_FIELDS RF\n"
-            + "  on RF.RDB$FIELD_NAME = IDX.RDB$FIELD_NAME and RF.RDB$RELATION_NAME = RC.RDB$RELATION_NAME\n"
-            + "inner join RDB$FIELDS F\n"
-            + "  on F.RDB$FIELD_NAME = RF.RDB$FIELD_SOURCE\n"
-            + "where RC.RDB$CONSTRAINT_TYPE = 'PRIMARY KEY'\n"
-            + "and ";
-
-    private static final String GET_BEST_ROW_IDENT_END =
-            "\norder by IDX.RDB$FIELD_POSITION";
-    //@formatter:on
-
     private GetBestRowIdentifier(DbMetadataMediator mediator) {
         super(ROW_DESCRIPTOR, mediator);
     }
@@ -93,7 +68,7 @@ public ResultSet getBestRowIdentifier(String catalog, String schema, String tabl
         }
 
         RowValueBuilder valueBuilder = new RowValueBuilder(ROW_DESCRIPTOR);
-        List<RowValue> rows = getPrimaryKeyIdentifier(table, valueBuilder);
+        List<RowValue> rows = getPrimaryKeyIdentifier(schema, table, valueBuilder);
 
         // if no primary key exists, add RDB$DB_KEY as pseudo-column
         if (rows.isEmpty()) {
@@ -105,8 +80,8 @@ public ResultSet getBestRowIdentifier(String catalog, String schema, String tabl
                 return createEmpty();
             }
 
-            try (ResultSet pseudoColumns =
-                         dbmd.getPseudoColumns(catalog, schema, escapeWildcards(table), "RDB$DB\\_KEY")) {
+            try (ResultSet pseudoColumns = dbmd.getPseudoColumns(
+                    catalog, escapeWildcards(schema), escapeWildcards(table), "RDB$DB\\_KEY")) {
                 if (!pseudoColumns.next()) {
                     return createEmpty();
                 }
@@ -118,7 +93,7 @@ public ResultSet getBestRowIdentifier(String catalog, String schema, String tabl
                         .at(1).setString("RDB$DB_KEY")
                         .at(2).setInt(Types.ROWID)
                         .at(3).setString(getDataTypeName(char_type, 0, CS_BINARY))
-                        .at(4).setInt(pseudoColumns.getInt(8))
+                        .at(4).setInt(pseudoColumns.getInt(6))
                         .at(5).set(null)
                         .at(6).set(null)
                         .at(7).setShort(DatabaseMetaData.bestRowPseudo)
@@ -132,22 +107,20 @@ public ResultSet getBestRowIdentifier(String catalog, String schema, String tabl
     /**
      * Get primary key of the table as best row identifier.
      *
+     * @param schema
+     *         name of the schema
      * @param table
-     *         name of the table.
+     *         name of the table
      * @param valueBuilder
      *         builder for row values
      * @return list of result set values, when empty, no primary key has been defined for a table or the table does not
      * exist. The returned list can be modified by caller if needed.
      * @throws SQLException
      *         if something went wrong.
      */
-    private List<RowValue> getPrimaryKeyIdentifier(String table, RowValueBuilder valueBuilder) throws SQLException {
-        Clause tableClause = Clause.equalsClause("RC.RDB$RELATION_NAME", table);
-        String sql = GET_BEST_ROW_IDENT_START
-                + tableClause.getCondition(false)
-                + GET_BEST_ROW_IDENT_END;
-
-        MetadataQuery metadataQuery = new MetadataQuery(sql, Clause.parameters(tableClause));
+    private List<RowValue> getPrimaryKeyIdentifier(String schema, String table, RowValueBuilder valueBuilder)
+            throws SQLException {
+        MetadataQuery metadataQuery = createGetPrimaryKeyIdentifierQuery(schema, table);
         try (ResultSet rs = mediator.performMetaDataQuery(metadataQuery)) {
             List<RowValue> rows = new ArrayList<>();
             while (rs.next()) {
@@ -157,6 +130,8 @@ private List<RowValue> getPrimaryKeyIdentifier(String table, RowValueBuilder val
         }
     }
 
+    abstract MetadataQuery createGetPrimaryKeyIdentifierQuery(String schema, String table);
+
     @Override
     RowValue createMetadataRow(ResultSet rs, RowValueBuilder valueBuilder) throws SQLException {
         TypeMetadata typeMetadata = TypeMetadata.builder(mediator.getFirebirdSupportInfo())
@@ -176,6 +151,119 @@ RowValue createMetadataRow(ResultSet rs, RowValueBuilder valueBuilder) throws SQ
     }
 
     public static GetBestRowIdentifier create(DbMetadataMediator mediator) {
-        return new GetBestRowIdentifier(mediator);
+        // NOTE: Indirection through static method prevents unnecessary classloading
+        if (mediator.getFirebirdSupportInfo().isVersionEqualOrAbove(6)) {
+            return FB6.createInstance(mediator);
+        } else {
+            return FB5.createInstance(mediator);
+        }
     }
+
+    /**
+     * Implementation for Firebird 5.0 and older.
+     */
+    private static final class FB5 extends GetBestRowIdentifier {
+
+        //@formatter:off
+        private static final String GET_BEST_ROW_IDENT_START = """
+                select
+                  RF.RDB$FIELD_NAME as COLUMN_NAME,
+                """ +
+                "  F.RDB$FIELD_TYPE as " + FIELD_TYPE + ",\n" +
+                "  F.RDB$FIELD_SUB_TYPE as " + FIELD_SUB_TYPE + ",\n" +
+                "  F.RDB$FIELD_PRECISION as " + FIELD_PRECISION + ",\n" +
+                "  F.RDB$FIELD_SCALE as " + FIELD_SCALE + ",\n" +
+                "  F.RDB$FIELD_LENGTH as " + FIELD_LENGTH + ",\n" +
+                "  F.RDB$CHARACTER_LENGTH as " + CHAR_LEN + ",\n" +
+                "  F.RDB$CHARACTER_SET_ID as " + CHARSET_ID + "\n" + """
+                from RDB$RELATION_CONSTRAINTS RC
+                inner join RDB$INDEX_SEGMENTS IDX
+                  on IDX.RDB$INDEX_NAME = RC.RDB$INDEX_NAME
+                inner join RDB$RELATION_FIELDS RF
+                  on RF.RDB$FIELD_NAME = IDX.RDB$FIELD_NAME and RF.RDB$RELATION_NAME = RC.RDB$RELATION_NAME
+                inner join RDB$FIELDS F
+                  on F.RDB$FIELD_NAME = RF.RDB$FIELD_SOURCE
+                where RC.RDB$CONSTRAINT_TYPE = 'PRIMARY KEY'
+                and\s""";
+        //@formatter:on
+
+        private static final String GET_BEST_ROW_IDENT_END = "\norder by IDX.RDB$FIELD_POSITION";
+
+
+        private FB5(DbMetadataMediator mediator) {
+            super(mediator);
+        }
+
+        private static GetBestRowIdentifier createInstance(DbMetadataMediator mediator) {
+            return new FB5(mediator);
+        }
+
+        @Override
+        MetadataQuery createGetPrimaryKeyIdentifierQuery(String schema, String table) {
+            Clause tableClause = Clause.equalsClause("RC.RDB$RELATION_NAME", table);
+            String sql = GET_BEST_ROW_IDENT_START
+                    + tableClause.getCondition(false)
+                    + GET_BEST_ROW_IDENT_END;
+
+            return new MetadataQuery(sql, Clause.parameters(tableClause));
+        }
+    }
+
+    /**
+     * Implementation for Firebird 6.0 and higher.
+     */
+    private static final class FB6 extends GetBestRowIdentifier {
+
+        //@formatter:off
+        private static final String GET_BEST_ROW_IDENT_START_6 = """
+                select
+                  RF.RDB$FIELD_NAME as COLUMN_NAME,
+                """ +
+                "  F.RDB$FIELD_TYPE as " + FIELD_TYPE + ",\n" +
+                "  F.RDB$FIELD_SUB_TYPE as " + FIELD_SUB_TYPE + ",\n" +
+                "  F.RDB$FIELD_PRECISION as " + FIELD_PRECISION + ",\n" +
+                "  F.RDB$FIELD_SCALE as " + FIELD_SCALE + ",\n" +
+                "  F.RDB$FIELD_LENGTH as " + FIELD_LENGTH + ",\n" +
+                "  F.RDB$CHARACTER_LENGTH as " + CHAR_LEN + ",\n" +
+                "  F.RDB$CHARACTER_SET_ID as " + CHARSET_ID + "\n" + """
+                from SYSTEM.RDB$RELATION_CONSTRAINTS RC
+                inner join SYSTEM.RDB$INDEX_SEGMENTS IDX
+                  on IDX.RDB$SCHEMA_NAME = RC.RDB$SCHEMA_NAME and IDX.RDB$INDEX_NAME = RC.RDB$INDEX_NAME
+                inner join SYSTEM.RDB$RELATION_FIELDS RF
+                  on RF.RDB$FIELD_NAME = IDX.RDB$FIELD_NAME and RF.RDB$SCHEMA_NAME = RC.RDB$SCHEMA_NAME and RF.RDB$RELATION_NAME = RC.RDB$RELATION_NAME
+                inner join SYSTEM.RDB$FIELDS F
+                  on F.RDB$SCHEMA_NAME = RF.RDB$FIELD_SOURCE_SCHEMA_NAME and F.RDB$FIELD_NAME = RF.RDB$FIELD_SOURCE
+                where RC.RDB$CONSTRAINT_TYPE = 'PRIMARY KEY'
+                and\s""";
+        //@formatter:on
+
+        // The order by schema name is to ensure a consistent order when this is called with schema = null, as that will
+        // not narrow the search by schema, so can return columns of multiple same named tables in different schemas.
+        private static final String GET_BEST_ROW_IDENT_END_6 = "\norder by RC.RDB$SCHEMA_NAME, IDX.RDB$FIELD_POSITION";
+
+        private FB6(DbMetadataMediator mediator) {
+            super(mediator);
+        }
+
+        private static GetBestRowIdentifier createInstance(DbMetadataMediator mediator) {
+            return new FB6(mediator);
+        }
+
+        @Override
+        MetadataQuery createGetPrimaryKeyIdentifierQuery(String schema, String table) {
+            List<Clause> clauses = new ArrayList<>(2);
+            if (schema != null) {
+                // NOTE: empty string will return no rows as required ("" retrieves those without a schema)
+                clauses.add(Clause.equalsClause("RC.RDB$SCHEMA_NAME", schema));
+            }
+            clauses.add(Clause.equalsClause("RC.RDB$RELATION_NAME", table));
+            String sql = GET_BEST_ROW_IDENT_START_6
+                    + Clause.conjunction(clauses)
+                    + GET_BEST_ROW_IDENT_END_6;
+
+            return new MetadataQuery(sql, Clause.parameters(clauses));
+        }
+
+    }
+
 }

src/test/org/firebirdsql/common/FBTestProperties.java

@@ -366,6 +366,19 @@ public static void defaultDatabaseTearDown(FBManager fbManager) throws Exception
         }
     }
 
+    /**
+     * If schema support is available, returns {@code forSchema}, otherwise returns {@code withoutSchema}.
+     *
+     * @param forSchema
+     *         value to return when schema support is available
+     * @param withoutSchema
+     *         value to return when schema support is not available
+     * @return {@code forSchema} if schema support is available, otherwise {@code withoutSchema}
+     */
+    public static <T> T ifSchemaElse(T forSchema, T withoutSchema) {
+        return getDefaultSupportInfo().supportsSchemas() ? forSchema : withoutSchema;
+    }
+
     private FBTestProperties() {
         // No instantiation
     }