Correct documentation of getXXXSourceCode methods

mrotteveel · mrotteveel · commit a35a3a038d24 · 2025-10-30T13:35:04.000+01:00
- Fix typo in table name
- Add tests
diff --git a/src/docs/asciidoc/release_notes.adoc b/src/docs/asciidoc/release_notes.adoc
@@ -582,6 +582,8 @@ The `schema` can be `null` or empty string for schemaless tables (i.e. Firebird
 [#other-fixes-and-changes]
 === Other fixes and changes
 
+* Changed the documentation of `FirebirdDatabaseMetaData` methods `getProcedureSourceCode`, `getTriggerSourceCode` and `getViewSourceCode` that the object not being found is reported by a `null` value, not a `SQLException`.
+With this change, the documentation reflects the actual behaviour.
 * ...
 
 [#compatibility-changes]
diff --git a/src/main/org/firebirdsql/jdbc/FBDatabaseMetaData.java b/src/main/org/firebirdsql/jdbc/FBDatabaseMetaData.java
@@ -1898,7 +1898,7 @@ public String getViewSourceCode(String schema, String viewName) throws SQLExcept
 
     private enum SourceObjectType {
         PROCEDURE("RDB$PROCEDURES", "RDB$PROCEDURE_SOURCE", "RDB$PROCEDURE_NAME"),
-        TRIGGER("RDB$TRIGGERS", "RDB$TRIGGER_SOUCE", "RDB$TRIGGER_NAME"),
+        TRIGGER("RDB$TRIGGERS", "RDB$TRIGGER_SOURCE", "RDB$TRIGGER_NAME"),
         VIEW("RDB$RELATIONS", "RDB$VIEW_SOURCE", "RDB$RELATION_NAME"),
         ;
 
diff --git a/src/main/org/firebirdsql/jdbc/FirebirdDatabaseMetaData.java b/src/main/org/firebirdsql/jdbc/FirebirdDatabaseMetaData.java
@@ -54,9 +54,9 @@ public interface FirebirdDatabaseMetaData extends DatabaseMetaData {
      *
      * @param procedureName
      *         name of the stored procedure
-     * @return source of the stored procedure
+     * @return source of the stored procedure, or {@code null} if not found or if the source column is {@code NULL}
      * @throws SQLException
-     *         if specified procedure cannot be found
+     *         for database access errors
      * @deprecated use {@link DatabaseMetaData#getProcedures(String, String, String)}, column
      * {@code JB_PROCEDURE_SOURCE}; there are currently no plans to remove this method
      */
@@ -72,9 +72,9 @@ public interface FirebirdDatabaseMetaData extends DatabaseMetaData {
      *
      * @param triggerName
      *         name of the trigger
-     * @return source of the trigger
+     * @return source of the trigger, or {@code null} if not found or if the source column is {@code NULL}
      * @throws SQLException
-     *         if specified trigger cannot be found
+     *         for database access errors
      * @see #getTriggerSourceCode(String, String)
      */
     String getTriggerSourceCode(String triggerName) throws SQLException;
@@ -86,9 +86,9 @@ public interface FirebirdDatabaseMetaData extends DatabaseMetaData {
      *         schema of the trigger ({@code null} drops the schema from the search; ignored on Firebird 5.0 and older)
      * @param triggerName
      *         name of the trigger
-     * @return source of the trigger
+     * @return source of the trigger, or {@code null} if not found or if the source column is {@code NULL}
      * @throws SQLException
-     *         if specified trigger cannot be found
+     *         for database access errors
      * @since 7
      */
     String getTriggerSourceCode(String schema, String triggerName) throws SQLException;
@@ -105,9 +105,9 @@ public interface FirebirdDatabaseMetaData extends DatabaseMetaData {
      *
      * @param viewName
      *         name of the view
-     * @return source of the view
+     * @return source of the view, or {@code null} if not found or if the source column is {@code NULL}
      * @throws SQLException
-     *         if specified view cannot be found
+     *         for database access errors
      * @see #getViewSourceCode(String, String)
      */
     String getViewSourceCode(String viewName) throws SQLException;
@@ -119,9 +119,9 @@ public interface FirebirdDatabaseMetaData extends DatabaseMetaData {
      *         schema of the trigger ({@code null} drops the schema from the search; ignored on Firebird 5.0 and older)
      * @param viewName
      *         name of the view
-     * @return source of the view
+     * @return source of the view, or {@code null} if not found or if the source column is {@code NULL}
      * @throws SQLException
-     *         if specified view cannot be found
+     *         for database access errors
      * @since 7
      */
     String getViewSourceCode(String schema, String viewName) throws SQLException;
diff --git a/src/test/org/firebirdsql/jdbc/FBDatabaseMetaDataTest.java b/src/test/org/firebirdsql/jdbc/FBDatabaseMetaDataTest.java
@@ -27,8 +27,13 @@
 
 import static java.lang.String.format;
 import static org.firebirdsql.common.FBTestProperties.*;
+import static org.firebirdsql.common.FbAssumptions.assumeSchemaSupport;
 import static org.firebirdsql.common.matchers.MatcherAssume.assumeThat;
 import static org.firebirdsql.common.matchers.RegexMatcher.matchesRegex;
+import static org.firebirdsql.gds.ISCConstants.isc_dsql_drop_trigger_failed;
+import static org.firebirdsql.gds.ISCConstants.isc_dsql_table_not_found;
+import static org.firebirdsql.gds.ISCConstants.isc_dsql_view_not_found;
+import static org.firebirdsql.gds.ISCConstants.isc_no_meta_update;
 import static org.firebirdsql.jdbc.FBDatabaseMetaData.*;
 import static org.firebirdsql.util.FirebirdSupportInfo.supportInfoFor;
 import static org.hamcrest.CoreMatchers.anyOf;
@@ -44,7 +49,6 @@
  *
  * @author David Jencks
  * @author Mark Rotteveel
- * @version 1.0
  */
 class FBDatabaseMetaDataTest {
 
@@ -802,6 +806,137 @@ void testSupportsSchemasInXXX() {
         );
     }
 
+    @SuppressWarnings("deprecation")
+    @Test
+    void testGetProcedureSourceCode_String() throws SQLException {
+        var dbmd = connection.getMetaData().unwrap(FirebirdDatabaseMetaData.class);
+        assertNull(dbmd.getProcedureSourceCode("TEST_PROC_1"), "Expected no procedure source");
+
+        final String procedureBody = """
+                begin
+                  /* TEST_PROC_1 body */
+                end""";
+        try (var stmt = connection.createStatement()) {
+            stmt.execute("create procedure TEST_PROC_1 (VARIN integer) as " + procedureBody);
+        }
+
+        assertEquals(procedureBody, dbmd.getProcedureSourceCode("TEST_PROC_1"), "Procedure source");
+    }
+
+    @Test
+    void testGetTriggerSourceCode_String() throws SQLException {
+        var dbmd = connection.getMetaData().unwrap(FirebirdDatabaseMetaData.class);
+        assertNull(dbmd.getTriggerSourceCode("TEST_TRIG_1"), "Expected no trigger source");
+
+        final String triggerBody = """
+                as
+                begin
+                  /* TEST_TRIG_1 body */
+                end""";
+
+        try (var stmt = connection.createStatement()) {
+            connection.setAutoCommit(false);
+            try {
+                stmt.execute("create table TEST_1 (id integer)");
+                stmt.execute("create trigger TEST_TRIG_1 before insert on TEST_1 " + triggerBody);
+                connection.commit();
+
+                assertEquals(triggerBody, dbmd.getTriggerSourceCode("TEST_TRIG_1"), "Trigger source");
+            } finally {
+                DdlHelper.executeDDL(stmt, List.of("drop table TEST_1"), isc_no_meta_update, isc_dsql_table_not_found,
+                        isc_dsql_view_not_found, isc_dsql_drop_trigger_failed);
+            }
+        } finally {
+            connection.setAutoCommit(false);
+        }
+    }
+
+    @Test
+    void testGetTriggerSourceCode_String_String() throws SQLException {
+        assumeSchemaSupport();
+        var dbmd = connection.getMetaData().unwrap(FirebirdDatabaseMetaData.class);
+        assertNull(dbmd.getTriggerSourceCode("TEST_SCHEMA_1", "TEST_TRIG_1"), "Expected no trigger source");
+
+        final String triggerBody = """
+                as
+                begin
+                  /* TEST_SCHEMA_1.TEST_TRIG_1 body */
+                end""";
+
+        try (var stmt = connection.createStatement()) {
+            connection.setAutoCommit(false);
+            try {
+                stmt.execute("create schema TEST_SCHEMA_1");
+                stmt.execute("create table TEST_SCHEMA_1.TEST_1 (id integer)");
+                stmt.execute("create trigger TEST_TRIG_1 before insert on TEST_SCHEMA_1.TEST_1 " + triggerBody);
+                connection.commit();
+
+                assertEquals(triggerBody, dbmd.getTriggerSourceCode("TEST_SCHEMA_1", "TEST_TRIG_1"), "Trigger source");
+                assertEquals(triggerBody, dbmd.getTriggerSourceCode("TEST_TRIG_1"), "Trigger source");
+                assertNull(dbmd.getTriggerSourceCode("PUBLIC", "TEST_TRIG_1"), "Expected no trigger source");
+            } finally {
+                DdlHelper.executeDDL(stmt, List.of("drop table TEST_SCHEMA_1.TEST_1", "drop schema TEST_SCHEMA_1"),
+                        isc_no_meta_update, isc_dsql_table_not_found, isc_dsql_view_not_found,
+                        isc_dsql_drop_trigger_failed);
+                // TODO Add schema support: error code for drop schema failure?
+            }
+        } finally {
+            connection.setAutoCommit(true);
+        }
+
+
+    }
+
+    @Test
+    void testGetViewSourceCode_String() throws SQLException {
+        var dbmd = connection.getMetaData().unwrap(FirebirdDatabaseMetaData.class);
+        assertNull(dbmd.getViewSourceCode("TEST_VIEW_1"), "Expected no view source");
+
+        final String viewBody = """
+                select 'TEST_VIEW_1' as VIEW_NAME, 1 as SOME_COLUMN
+                from RDB$DATABASE""";
+        try (var stmt = connection.createStatement()) {
+            try {
+                stmt.execute("create view TEST_VIEW_1 as " + viewBody);
+
+                assertEquals(viewBody, dbmd.getViewSourceCode("TEST_VIEW_1"), "View source");
+            } finally {
+                DdlHelper.executeDDL(stmt, List.of("drop view TEST_VIEW_1"), isc_no_meta_update,
+                        isc_dsql_table_not_found, isc_dsql_view_not_found, isc_dsql_drop_trigger_failed);
+            }
+        }
+    }
+
+    @Test
+    void testGetViewSourceCode_String_String() throws SQLException {
+        assumeSchemaSupport();
+        var dbmd = connection.getMetaData().unwrap(FirebirdDatabaseMetaData.class);
+        assertNull(dbmd.getViewSourceCode("TEST_SCHEMA_1", "TEST_VIEW_1"), "Expected no view source");
+
+        final String viewBody = """
+                select 'TEST_SCHEMA_1' as VIEW_SCHEMA, 'TEST_VIEW_1' as VIEW_NAME, 1 as SOME_COLUMN
+                from RDB$DATABASE""";
+        try (var stmt = connection.createStatement()) {
+            connection.setAutoCommit(false);
+            try {
+                stmt.execute("create schema TEST_SCHEMA_1");
+                stmt.execute("create view TEST_SCHEMA_1.TEST_VIEW_1 as " + viewBody);
+                connection.commit();
+
+                assertEquals(viewBody, dbmd.getViewSourceCode("TEST_SCHEMA_1", "TEST_VIEW_1"), "View source");
+                assertEquals(viewBody, dbmd.getViewSourceCode("TEST_VIEW_1"), "View source");
+                assertNull(dbmd.getViewSourceCode("PUBLIC", "TEST_VIEW_1"), "Expected no view source");
+            } finally {
+                DdlHelper.executeDDL(stmt, List.of("drop view TEST_SCHEMA_1.TEST_VIEW_1", "drop schema TEST_SCHEMA_1"),
+                        isc_no_meta_update, isc_dsql_table_not_found, isc_dsql_view_not_found,
+                        isc_dsql_drop_trigger_failed);
+                // TODO Add schema support: error code for drop schema failure?
+            }
+        } finally {
+            connection.setAutoCommit(true);
+        }
+    }
+
     @SuppressWarnings("SameParameterValue")
     private void createPackage(String packageName, String procedureName) throws Exception {
         try (Statement stmt = connection.createStatement()) {

Original file line number	Diff line number	Diff line change
`@@ -1898,7 +1898,7 @@ public String getViewSourceCode(String schema, String viewName) throws SQLExcept`
`1898`	`1898`
`1899`	`1899`	`private enum SourceObjectType {`
`1900`	`1900`	`PROCEDURE("RDB$PROCEDURES", "RDB$PROCEDURE_SOURCE", "RDB$PROCEDURE_NAME"),`
`1901`		`- TRIGGER("RDB$TRIGGERS", "RDB$TRIGGER_SOUCE", "RDB$TRIGGER_NAME"),`
	`1901`	`+ TRIGGER("RDB$TRIGGERS", "RDB$TRIGGER_SOURCE", "RDB$TRIGGER_NAME"),`
`1902`	`1902`	`VIEW("RDB$RELATIONS", "RDB$VIEW_SOURCE", "RDB$RELATION_NAME"),`
`1903`	`1903`	`;`
`1904`	`1904`