#882 Schema support for getPrimaryKeys

Author: mrotteveel

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

@@ -1428,7 +1428,7 @@ public ResultSet getVersionColumns(String catalog, String schema, String table)
      */
     @Override
     public ResultSet getPrimaryKeys(String catalog, String schema, String table) throws SQLException {
-        return GetPrimaryKeys.create(getDbMetadataMediator()).getPrimaryKeys(table);
+        return GetPrimaryKeys.create(getDbMetadataMediator()).getPrimaryKeys(schema, table);
     }
 
     /**

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

@@ -251,7 +251,7 @@ private static GetBestRowIdentifier createInstance(DbMetadataMediator mediator)
 
         @Override
         MetadataQuery createGetPrimaryKeyIdentifierQuery(String schema, String table) {
-            List<Clause> clauses = new ArrayList<>(2);
+           var clauses = new ArrayList<Clause>(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));

src/main/org/firebirdsql/jdbc/metadata/GetPrimaryKeys.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;
 
@@ -10,6 +10,7 @@
 
 import java.sql.ResultSet;
 import java.sql.SQLException;
+import java.util.ArrayList;
 
 import static org.firebirdsql.gds.ISCConstants.SQL_SHORT;
 import static org.firebirdsql.gds.ISCConstants.SQL_VARYING;
@@ -22,7 +23,7 @@
  * @author Mark Rotteveel
  * @since 5
  */
-public final class GetPrimaryKeys extends AbstractMetadataMethod {
+public abstract class GetPrimaryKeys extends AbstractMetadataMethod {
 
     private static final String COLUMNINFO = "COLUMNINFO";
 
@@ -36,42 +37,25 @@ public final class GetPrimaryKeys extends AbstractMetadataMethod {
             .at(6).simple(SQL_VARYING, OBJECT_NAME_LENGTH, "JB_PK_INDEX_NAME", COLUMNINFO).addField()
             .toRowDescriptor();
 
-    private static final String GET_PRIMARY_KEYS_START = """
-            select
-              RC.RDB$RELATION_NAME as TABLE_NAME,
-              ISGMT.RDB$FIELD_NAME as COLUMN_NAME,
-              ISGMT.RDB$FIELD_POSITION + 1 as KEY_SEQ,
-              RC.RDB$CONSTRAINT_NAME as PK_NAME,
-              RC.RDB$INDEX_NAME as JB_PK_INDEX_NAME
-            from RDB$RELATION_CONSTRAINTS RC
-            inner join RDB$INDEX_SEGMENTS ISGMT
-              on RC.RDB$INDEX_NAME = ISGMT.RDB$INDEX_NAME
-            where RC.RDB$CONSTRAINT_TYPE = 'PRIMARY KEY'
-            and\s""";
-
-    private static final String GET_PRIMARY_KEYS_END = "\norder by ISGMT.RDB$FIELD_NAME ";
-
     private GetPrimaryKeys(DbMetadataMediator mediator) {
         super(ROW_DESCRIPTOR, mediator);
     }
 
-    public ResultSet getPrimaryKeys(String table) throws SQLException {
+    public final ResultSet getPrimaryKeys(String schema, String table) throws SQLException {
         if (isNullOrEmpty(table)) {
             return createEmpty();
         }
-        Clause tableClause = Clause.equalsClause("RC.RDB$RELATION_NAME", table);
-        String sql = GET_PRIMARY_KEYS_START
-                + tableClause.getCondition(false)
-                + GET_PRIMARY_KEYS_END;
-        MetadataQuery metadataQuery = new MetadataQuery(sql, Clause.parameters(tableClause));
+        MetadataQuery metadataQuery = createGetPrimaryKeysQuery(schema, table);
         return createMetaDataResultSet(metadataQuery);
     }
 
+    abstract MetadataQuery createGetPrimaryKeysQuery(String schema, String table);
+
     @Override
     RowValue createMetadataRow(ResultSet rs, RowValueBuilder valueBuilder) throws SQLException {
         return valueBuilder
                 .at(0).set(null)
-                .at(1).set(null)
+                .at(1).setString(rs.getString("TABLE_SCHEM"))
                 .at(2).setString(rs.getString("TABLE_NAME"))
                 .at(3).setString(rs.getString("COLUMN_NAME"))
                 .at(4).setShort(rs.getShort("KEY_SEQ"))
@@ -81,6 +65,99 @@ RowValue createMetadataRow(ResultSet rs, RowValueBuilder valueBuilder) throws SQ
     }
 
     public static GetPrimaryKeys create(DbMetadataMediator mediator) {
-        return new GetPrimaryKeys(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 GetPrimaryKeys {
+
+        private static final String GET_PRIMARY_KEYS_START_5 = """
+            select
+              cast(null as char(1)) as TABLE_SCHEM,
+              RC.RDB$RELATION_NAME as TABLE_NAME,
+              ISGMT.RDB$FIELD_NAME as COLUMN_NAME,
+              ISGMT.RDB$FIELD_POSITION + 1 as KEY_SEQ,
+              RC.RDB$CONSTRAINT_NAME as PK_NAME,
+              RC.RDB$INDEX_NAME as JB_PK_INDEX_NAME
+            from RDB$RELATION_CONSTRAINTS RC
+            inner join RDB$INDEX_SEGMENTS ISGMT
+              on RC.RDB$INDEX_NAME = ISGMT.RDB$INDEX_NAME
+            where RC.RDB$CONSTRAINT_TYPE = 'PRIMARY KEY'
+            and\s""";
+
+        private static final String GET_PRIMARY_KEYS_END_5 = "\norder by ISGMT.RDB$FIELD_NAME";
+
+        private FB5(DbMetadataMediator mediator) {
+            super(mediator);
+        }
+
+        private static GetPrimaryKeys createInstance(DbMetadataMediator mediator) {
+            return new FB5(mediator);
+        }
+
+        @Override
+        MetadataQuery createGetPrimaryKeysQuery(String schema, String table) {
+            Clause tableClause = Clause.equalsClause("RC.RDB$RELATION_NAME", table);
+            String sql = GET_PRIMARY_KEYS_START_5
+                    + tableClause.getCondition(false)
+                    + GET_PRIMARY_KEYS_END_5;
+            return new MetadataQuery(sql, Clause.parameters(tableClause));
+        }
+
+    }
+
+    /**
+     * Implementation for Firebird 6.0 and higher.
+     */
+    private static final class FB6 extends GetPrimaryKeys {
+
+        private static final String GET_PRIMARY_KEYS_START_6 = """
+            select
+              trim(trailing from RC.RDB$SCHEMA_NAME) as TABLE_SCHEM,
+              trim(trailing from RC.RDB$RELATION_NAME) as TABLE_NAME,
+              trim(trailing from ISGMT.RDB$FIELD_NAME) as COLUMN_NAME,
+              ISGMT.RDB$FIELD_POSITION + 1 as KEY_SEQ,
+              trim(trailing from RC.RDB$CONSTRAINT_NAME) as PK_NAME,
+              trim(trailing from RC.RDB$INDEX_NAME) as JB_PK_INDEX_NAME
+            from SYSTEM.RDB$RELATION_CONSTRAINTS RC
+            inner join SYSTEM.RDB$INDEX_SEGMENTS ISGMT
+              on RC.RDB$SCHEMA_NAME = ISGMT.RDB$SCHEMA_NAME and RC.RDB$INDEX_NAME = ISGMT.RDB$INDEX_NAME
+            where RC.RDB$CONSTRAINT_TYPE = 'PRIMARY KEY'
+            and\s""";
+
+        // For consistent order (e.g. for tests), we're also sorting on schema name.
+        // JDBC specifies that the result set is sorted on COLUMN_NAME, so we can't sort on schema first
+        private static final String GET_PRIMARY_KEYS_END_6 = "\norder by ISGMT.RDB$FIELD_NAME, ISGMT.RDB$SCHEMA_NAME";
+
+        private FB6(DbMetadataMediator mediator) {
+            super(mediator);
+        }
+
+        private static GetPrimaryKeys createInstance(DbMetadataMediator mediator) {
+            return new FB6(mediator);
+        }
+
+        @Override
+        MetadataQuery createGetPrimaryKeysQuery(String schema, String table) {
+            var clauses = new ArrayList<Clause>(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_PRIMARY_KEYS_START_6
+                    + Clause.conjunction(clauses)
+                    + GET_PRIMARY_KEYS_END_6;
+            return new MetadataQuery(sql, Clause.parameters(clauses));
+        }
+
+    }
+
 }

src/test/org/firebirdsql/jdbc/FBDatabaseMetaDataPrimaryKeysTest.java

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: Copyright 2024 Mark Rotteveel
+// SPDX-FileCopyrightText: Copyright 2024-2025 Mark Rotteveel
 // SPDX-License-Identifier: LGPL-2.1-or-later
 package org.firebirdsql.jdbc;
 
@@ -20,6 +20,7 @@
 
 import static java.util.Collections.unmodifiableMap;
 import static org.firebirdsql.common.FBTestProperties.getConnectionViaDriverManager;
+import static org.firebirdsql.common.FBTestProperties.ifSchemaElse;
 import static org.firebirdsql.common.assertions.ResultSetAssertions.assertNextRow;
 import static org.firebirdsql.common.assertions.ResultSetAssertions.assertNoNextRow;
 
@@ -30,6 +31,8 @@
  */
 class FBDatabaseMetaDataPrimaryKeysTest {
 
+    // TODO Add schema support: tests involving other schema
+
     private static final String UNNAMED_CONSTRAINT_PREFIX = "INTEG_";
     private static final String UNNAMED_PK_INDEX_PREFIX = "RDB$PRIMARY";
 
@@ -170,6 +173,7 @@ private void validateExpectedPrimaryKeys(String tableName, List<Map<PrimaryKeysM
     static {
         var defaults = new EnumMap<>(PrimaryKeysMetaData.class);
         Arrays.stream(PrimaryKeysMetaData.values()).forEach(key -> defaults.put(key, null));
+        defaults.put(PrimaryKeysMetaData.TABLE_SCHEM, ifSchemaElse("PUBLIC", null));
         DEFAULT_COLUMN_VALUES = unmodifiableMap(defaults);
     }