#882 Schema support for getColumnPrivileges

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

@@ -1337,14 +1337,20 @@ public ResultSet getColumns(String catalog, String schemaPattern, String tableNa
      * </p>
      * <p>
      * <b>NOTE:</b> This implementation returns <b>all</b> privileges, not just applicable to the current user. It is
-     * unclear if this complies with the JDBC requirements. This may change in the future to only return only privileges
+     * unclear if this complies with the JDBC requirements. This may change in the future to only return privileges
      * applicable to the current user, user {@code PUBLIC} and &mdash; maybe &mdash; active roles.
      * </p>
+     * <p>
+     * Contrary to specified in the JDBC API, the result set is ordered by {@code TABLE_SCHEM}, {@code COLUMN_NAME},
+     * {@code PRIVILEGE}, and {@code GRANTEE} (JDBC specifies ordering by {@code COLUMN_NAME} and {@code PRIVILEGE}).
+     * This only makes a difference when specifying {@code null} for {@code schema} (search all schemas) and there are
+     * multiples tables with the same {@code name}.
+     * </p>
      */
     @Override
     public ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern)
             throws SQLException {
-        return GetColumnPrivileges.create(getDbMetadataMediator()).getColumnPrivileges(table, columnNamePattern);
+        return GetColumnPrivileges.create(getDbMetadataMediator()).getColumnPrivileges(schema, table, columnNamePattern);
     }
 
     /**

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

@@ -22,6 +22,7 @@
 import static org.firebirdsql.gds.ISCConstants.SQL_LONG;
 import static org.firebirdsql.gds.ISCConstants.SQL_SHORT;
 import static org.firebirdsql.gds.ISCConstants.SQL_VARYING;
+import static org.firebirdsql.jaybird.util.StringUtils.isNullOrEmpty;
 import static org.firebirdsql.jdbc.metadata.FbMetadataConstants.OBJECT_NAME_LENGTH;
 import static org.firebirdsql.jdbc.metadata.FbMetadataConstants.char_type;
 import static org.firebirdsql.jdbc.metadata.MetadataPattern.escapeWildcards;
@@ -63,7 +64,7 @@ private GetBestRowIdentifier(DbMetadataMediator mediator) {
     @SuppressWarnings("unused")
     public ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)
             throws SQLException {
-        if (table == null || table.isEmpty()) {
+        if (isNullOrEmpty(table)) {
             return createEmpty();
         }
 
@@ -204,7 +205,6 @@ MetadataQuery createGetPrimaryKeyIdentifierQuery(String schema, String table) {
             String sql = GET_BEST_ROW_IDENT_START
                     + tableClause.getCondition(false)
                     + GET_BEST_ROW_IDENT_END;
-
             return new MetadataQuery(sql, Clause.parameters(tableClause));
         }
     }
@@ -217,7 +217,7 @@ 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,
+                  trim(trailing from 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" +

src/main/org/firebirdsql/jdbc/metadata/GetColumnPrivileges.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,8 +10,11 @@
 
 import java.sql.ResultSet;
 import java.sql.SQLException;
+import java.util.ArrayList;
+import java.util.List;
 
 import static org.firebirdsql.gds.ISCConstants.SQL_VARYING;
+import static org.firebirdsql.jaybird.util.StringUtils.isNullOrEmpty;
 import static org.firebirdsql.jdbc.metadata.FbMetadataConstants.OBJECT_NAME_LENGTH;
 import static org.firebirdsql.jdbc.metadata.PrivilegeMapping.mapPrivilege;
 
@@ -27,7 +30,7 @@
  * @author Mark Rotteveel
  * @since 5
  */
-public final class GetColumnPrivileges extends AbstractMetadataMethod {
+public abstract class GetColumnPrivileges extends AbstractMetadataMethod {
 
     private static final String COLUMNPRIV = "COLUMNPRIV";
     private static final RowDescriptor ROW_DESCRIPTOR = DbMetadataMediator.newRowDescriptorBuilder(9)
@@ -42,60 +45,28 @@ public final class GetColumnPrivileges extends AbstractMetadataMethod {
             .at(8).simple(SQL_VARYING, OBJECT_NAME_LENGTH, "JB_GRANTEE_TYPE", COLUMNPRIV).addField()
             .toRowDescriptor();
 
-    //@formatter:off
-    private static final String GET_COLUMN_PRIVILEGES_START =
-            "select distinct \n"
-            + "  RF.RDB$RELATION_NAME as TABLE_NAME, \n"
-            + "  RF.RDB$FIELD_NAME as COLUMN_NAME, \n"
-            + "  UP.RDB$GRANTOR as GRANTOR, \n"
-            + "  UP.RDB$USER as GRANTEE, \n"
-            + "  UP.RDB$PRIVILEGE as PRIVILEGE, \n"
-            + "  UP.RDB$GRANT_OPTION as IS_GRANTABLE,\n"
-            + "  T.RDB$TYPE_NAME as JB_GRANTEE_TYPE\n"
-            + "from RDB$RELATION_FIELDS RF\n"
-            + "inner join RDB$USER_PRIVILEGES UP\n"
-            + "  on UP.RDB$RELATION_NAME = RF.RDB$RELATION_NAME \n"
-            + "    and (UP.RDB$FIELD_NAME is null or UP.RDB$FIELD_NAME = RF.RDB$FIELD_NAME) \n"
-            + "left join RDB$TYPES T\n"
-            + "  on T.RDB$FIELD_NAME = 'RDB$OBJECT_TYPE' and T.RDB$TYPE = UP.RDB$USER_TYPE \n"
-            // Other privileges don't make sense for column privileges
-            + "where UP.RDB$PRIVILEGE in ('A', 'D', 'I', 'R', 'S', 'U')\n"
-            // Only tables and views
-            + "and UP.RDB$OBJECT_TYPE in (0, 1)\n"
-            + "and ";
-
-    // NOTE: Sort by user is not defined in JDBC, but we do this to ensure a consistent order for tests
-    private static final String GET_COLUMN_PRIVILEGES_END =
-            "\norder by RF.RDB$FIELD_NAME, UP.RDB$PRIVILEGE, UP.RDB$USER";
-    //@formatter:on
-
     GetColumnPrivileges(DbMetadataMediator mediator) {
         super(ROW_DESCRIPTOR, mediator);
     }
 
     /**
      * @see java.sql.DatabaseMetaData#getColumnPrivileges(String, String, String, String) 
      */
-    public ResultSet getColumnPrivileges(String table, String columnNamePattern) throws SQLException  {
-        if (table == null || "".equals(columnNamePattern)) {
+    public ResultSet getColumnPrivileges(String schema, String table, String columnNamePattern) throws SQLException {
+        if (isNullOrEmpty(table) || "".equals(columnNamePattern)) {
             return createEmpty();
         }
-        Clause tableClause = Clause.equalsClause("RF.RDB$RELATION_NAME", table);
-        Clause columnNameClause = new Clause("RF.RDB$FIELD_NAME", columnNamePattern);
-
-        String sql = GET_COLUMN_PRIVILEGES_START
-                + tableClause.getCondition(columnNameClause.hasCondition())
-                + columnNameClause.getCondition(false)
-                + GET_COLUMN_PRIVILEGES_END;
-        MetadataQuery metadataQuery = new MetadataQuery(sql, Clause.parameters(tableClause, columnNameClause));
+        MetadataQuery metadataQuery = createMetadataQuery(schema, table, columnNamePattern);
         return createMetaDataResultSet(metadataQuery);
     }
 
+    abstract MetadataQuery createMetadataQuery(String schema, String table, String columnNamePattern);
+
     @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).setString(rs.getString("GRANTOR"))
@@ -107,6 +78,115 @@ RowValue createMetadataRow(ResultSet rs, RowValueBuilder valueBuilder) throws SQ
     }
 
     public static GetColumnPrivileges create(DbMetadataMediator mediator) {
-        return new GetColumnPrivileges(mediator);
+        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 GetColumnPrivileges {
+
+        private static final String GET_COLUMN_PRIVILEGES_START_5 = """
+            select distinct
+              cast(null as char(1)) as TABLE_SCHEM,
+              RF.RDB$RELATION_NAME as TABLE_NAME,
+              RF.RDB$FIELD_NAME as COLUMN_NAME,
+              UP.RDB$GRANTOR as GRANTOR,
+              UP.RDB$USER as GRANTEE,
+              UP.RDB$PRIVILEGE as PRIVILEGE,
+              UP.RDB$GRANT_OPTION as IS_GRANTABLE,
+              T.RDB$TYPE_NAME as JB_GRANTEE_TYPE
+            from RDB$RELATION_FIELDS RF
+            inner join RDB$USER_PRIVILEGES UP
+              on UP.RDB$RELATION_NAME = RF.RDB$RELATION_NAME
+                and (UP.RDB$FIELD_NAME is null or UP.RDB$FIELD_NAME = RF.RDB$FIELD_NAME)
+            left join RDB$TYPES T
+              on T.RDB$FIELD_NAME = 'RDB$OBJECT_TYPE' and T.RDB$TYPE = UP.RDB$USER_TYPE
+            where UP.RDB$PRIVILEGE in ('A', 'D', 'I', 'R', 'S', 'U') -- privileges relevant for columns
+            and UP.RDB$OBJECT_TYPE in (0, 1) -- only tables and views
+            and\s""";
+
+        // NOTE: Sort by user is not defined in JDBC, but we do this to ensure a consistent order for tests
+        private static final String GET_COLUMN_PRIVILEGES_END_5 =
+                "\norder by RF.RDB$FIELD_NAME, UP.RDB$PRIVILEGE, UP.RDB$USER";
+
+        private FB5(DbMetadataMediator mediator) {
+            super(mediator);
+        }
+
+        private static GetColumnPrivileges createInstance(DbMetadataMediator mediator) {
+            return new FB5(mediator);
+        }
+
+        @Override
+        MetadataQuery createMetadataQuery(String schema, String table, String columnNamePattern) {
+            var clauses = List.of(
+                    Clause.equalsClause("RF.RDB$RELATION_NAME", table),
+                    new Clause("RF.RDB$FIELD_NAME", columnNamePattern));
+            String sql = GET_COLUMN_PRIVILEGES_START_5
+                    + Clause.conjunction(clauses)
+                    + GET_COLUMN_PRIVILEGES_END_5;
+            return new MetadataQuery(sql, Clause.parameters(clauses));
+        }
+
     }
+
+    /**
+     * Implementation for Firebird 6.0 and higher.
+     */
+    private static final class FB6 extends GetColumnPrivileges {
+
+        private static final String GET_COLUMN_PRIVILEGES_START_6 = """
+            select distinct
+              trim(trailing from RF.RDB$SCHEMA_NAME) as TABLE_SCHEM,
+              trim(trailing from RF.RDB$RELATION_NAME) as TABLE_NAME,
+              trim(trailing from RF.RDB$FIELD_NAME) as COLUMN_NAME,
+              trim(trailing from UP.RDB$GRANTOR) as GRANTOR,
+              trim(trailing from UP.RDB$USER) as GRANTEE,
+              UP.RDB$PRIVILEGE as PRIVILEGE,
+              UP.RDB$GRANT_OPTION as IS_GRANTABLE,
+              T.RDB$TYPE_NAME as JB_GRANTEE_TYPE
+            from SYSTEM.RDB$RELATION_FIELDS RF
+            inner join SYSTEM.RDB$USER_PRIVILEGES UP
+              on UP.RDB$RELATION_SCHEMA_NAME = RF.RDB$SCHEMA_NAME and UP.RDB$RELATION_NAME = RF.RDB$RELATION_NAME
+                and (UP.RDB$FIELD_NAME is null or UP.RDB$FIELD_NAME = RF.RDB$FIELD_NAME)
+            left join SYSTEM.RDB$TYPES T
+              on T.RDB$FIELD_NAME = 'RDB$OBJECT_TYPE' and T.RDB$TYPE = UP.RDB$USER_TYPE
+            where UP.RDB$PRIVILEGE in ('A', 'D', 'I', 'R', 'S', 'U') -- privileges relevant for columns
+            and UP.RDB$OBJECT_TYPE in (0, 1) -- only tables and views
+            and\s""";
+
+        // NOTE: Sort by user and schema is not defined in JDBC, but we do this to ensure a consistent order for tests
+        private static final String GET_COLUMN_PRIVILEGES_END_6 =
+                "\norder by RF.RDB$FIELD_NAME, UP.RDB$PRIVILEGE, UP.RDB$USER, RF.RDB$SCHEMA_NAME";
+
+        private FB6(DbMetadataMediator mediator) {
+            super(mediator);
+        }
+
+        private static GetColumnPrivileges createInstance(DbMetadataMediator mediator) {
+            return new FB6(mediator);
+        }
+
+        @Override
+        MetadataQuery createMetadataQuery(String schema, String table, String columnNamePattern) {
+            var clauses = new ArrayList<Clause>(3);
+            if (schema != null) {
+                // NOTE: empty string will return no rows as required ("" retrieves those without a schema)
+                clauses.add(Clause.equalsClause("RF.RDB$SCHEMA_NAME", schema));
+            }
+            clauses.add(Clause.equalsClause("RF.RDB$RELATION_NAME", table));
+            clauses.add(new Clause("RF.RDB$FIELD_NAME", columnNamePattern));
+            String sql = GET_COLUMN_PRIVILEGES_START_6
+                    + Clause.conjunction(clauses)
+                    + GET_COLUMN_PRIVILEGES_END_6;
+            return new MetadataQuery(sql, Clause.parameters(clauses));
+        }
+
+    }
+
 }

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

@@ -107,8 +107,8 @@ private static final class FB2_5 extends GetProcedures {
 
         private static final String GET_PROCEDURES_FRAGMENT_2_5 = """
                 select
-                  null as PROCEDURE_CAT,
-                  null as PROCEDURE_SCHEM,
+                  cast(null as char(1)) as PROCEDURE_CAT,
+                  cast(null as char(1)) as PROCEDURE_SCHEM,
                   RDB$PROCEDURE_NAME as PROCEDURE_NAME,
                   RDB$DESCRIPTION as REMARKS,
                   RDB$PROCEDURE_OUTPUTS as PROCEDURE_TYPE

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

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: Copyright 2022-2023 Mark Rotteveel
+// SPDX-FileCopyrightText: Copyright 2022-2025 Mark Rotteveel
 // SPDX-License-Identifier: LGPL-2.1-or-later
 package org.firebirdsql.jdbc;
 
@@ -24,6 +24,7 @@
 
 import static org.firebirdsql.common.FBTestProperties.getConnectionViaDriverManager;
 import static org.firebirdsql.common.FBTestProperties.getDefaultSupportInfo;
+import static org.firebirdsql.common.FBTestProperties.ifSchemaElse;
 import static org.firebirdsql.common.matchers.MatcherAssume.assumeThat;
 import static org.hamcrest.Matchers.equalToIgnoringCase;
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -35,6 +36,8 @@
  */
 class FBDatabaseMetaDataColumnPrivilegesTest {
 
+    // TODO Add schema support: tests involving other schema
+
     private static final String SYSDBA = "SYSDBA";
     private static final String USER1 = "USER1";
     private static final String user2 = getDefaultSupportInfo().supportsCaseSensitiveUserNames() ? "user2" : "USER2";
@@ -125,7 +128,9 @@ void testColumnPrivileges_TBL1_all(String allPattern) throws Exception {
                 createRule("TBL1", "val3", USER1, false, "UPDATE"),
                 createRule("TBL1", "val3", user2, false, "UPDATE"));
 
-        validateExpectedColumnPrivileges("TBL1", allPattern, rules);
+        validateExpectedColumnPrivileges(ifSchemaElse("PUBLIC", ""), "TBL1", allPattern, rules);
+        // schema = null should also find it:
+        validateExpectedColumnPrivileges(null, "TBL1", allPattern, rules);
     }
 
     @Test
@@ -155,7 +160,9 @@ void testColumnPrivileges_TBL1_COL_wildcard() throws Exception {
                 createRule("TBL1", "COL2", SYSDBA, true, "UPDATE"),
                 createRule("TBL1", "COL2", USER1, false, "UPDATE"));
 
-        validateExpectedColumnPrivileges("TBL1", "COL%", rules);
+        validateExpectedColumnPrivileges(ifSchemaElse("PUBLIC", ""), "TBL1", "COL%", rules);
+        // schema = null should also find it:
+        validateExpectedColumnPrivileges(null, "TBL1", "COL%", rules);
     }
 
     @Test
@@ -181,23 +188,29 @@ void testColumnPrivileges_tbl2_all() throws Exception {
                 createRule("tbl2", "val3", user2, true, "SELECT"),
                 createRule("tbl2", "val3", SYSDBA, true, "UPDATE"));
 
-        validateExpectedColumnPrivileges("tbl2", "%", rules);
+        validateExpectedColumnPrivileges(ifSchemaElse("PUBLIC", ""), "tbl2", "%", rules);
     }
 
-    private Map<ColumnPrivilegesMetadata, Object> createRule(String tableName, String columnName, String grantee,
+    private Map<ColumnPrivilegesMetadata, Object> createRule(String table, String columnName, String grantee,
             boolean grantable, String privilege) {
+        return createRule(ifSchemaElse("PUBLIC", null), table, columnName, grantee, grantable, privilege);
+    }
+
+    private Map<ColumnPrivilegesMetadata, Object> createRule(String schema, String table, String columnName,
+            String grantee, boolean grantable, String privilege) {
         Map<ColumnPrivilegesMetadata, Object> rules = getDefaultValueValidationRules();
-        rules.put(ColumnPrivilegesMetadata.TABLE_NAME, tableName);
+        rules.put(ColumnPrivilegesMetadata.TABLE_SCHEM, schema);
+        rules.put(ColumnPrivilegesMetadata.TABLE_NAME, table);
         rules.put(ColumnPrivilegesMetadata.COLUMN_NAME, columnName);
         rules.put(ColumnPrivilegesMetadata.GRANTEE, grantee);
         rules.put(ColumnPrivilegesMetadata.PRIVILEGE, privilege);
         rules.put(ColumnPrivilegesMetadata.IS_GRANTABLE, grantable ? "YES" : "NO");
         return rules;
     }
 
-    private void validateExpectedColumnPrivileges(String tableName, String columnNamePattern,
+    private void validateExpectedColumnPrivileges(String schema, String table, String columnNamePattern,
             List<Map<ColumnPrivilegesMetadata, Object>> expectedColumnPrivileges) throws SQLException {
-        try (ResultSet columnPrivileges = dbmd.getColumnPrivileges(null, null, tableName, columnNamePattern)) {
+        try (ResultSet columnPrivileges = dbmd.getColumnPrivileges(null, schema, table, columnNamePattern)) {
             int privilegeCount = 0;
             while (columnPrivileges.next()) {
                 if (privilegeCount < expectedColumnPrivileges.size()) {
@@ -215,7 +228,7 @@ private void validateExpectedColumnPrivileges(String tableName, String columnNam
     static {
         Map<ColumnPrivilegesMetadata, Object> defaults = new EnumMap<>(ColumnPrivilegesMetadata.class);
         defaults.put(ColumnPrivilegesMetadata.TABLE_CAT, null);
-        defaults.put(ColumnPrivilegesMetadata.TABLE_SCHEM, null);
+        defaults.put(ColumnPrivilegesMetadata.TABLE_SCHEM, ifSchemaElse("PUBLIC", null));
         defaults.put(ColumnPrivilegesMetadata.GRANTOR, SYSDBA);
         defaults.put(ColumnPrivilegesMetadata.JB_GRANTEE_TYPE, "USER");