#882 schema support for generated keys

Author: mrotteveel

src/main/org/firebirdsql/jaybird/parser/StatementDetector.java

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: Copyright 2021-2024 Mark Rotteveel
+// SPDX-FileCopyrightText: Copyright 2021-2025 Mark Rotteveel
 // SPDX-License-Identifier: LGPL-2.1-or-later
 package org.firebirdsql.jaybird.parser;
 
@@ -14,8 +14,8 @@
  * Detects the type of statement, and - optionally - whether a DML statement has a {@code RETURNING} clause.
  * <p>
  * If the detected statement type is {@code UPDATE}, {@code DELETE}, {@code INSERT}, {@code UPDATE OR INSERT} and
- * {@code MERGE}, it identifies the affected table and - optionally - whether or not a {@code RETURNING} clause is
- * present (delegated to a {@link ReturningClauseDetector}).
+ * {@code MERGE}, it identifies the affected table and - optionally - if a {@code RETURNING} clause is present
+ * (delegated to a {@link ReturningClauseDetector}).
  * </p>
  * <p>
  * The types of statements detected are informed by the needs of Jaybird, and may change between point releases.
@@ -27,8 +27,6 @@
 @InternalApi
 public final class StatementDetector implements TokenVisitor {
 
- // TODO Add schema support: identify (optional) schema
-
  private static final StateAfterStart INITIAL_OTHER =
  new StateAfterStart(ParserState.OTHER, LocalStatementType.OTHER);
  private static final Map<CharSequence, StateAfterStart> NEXT_AFTER_START;
@@ -55,6 +53,7 @@ public final class StatementDetector implements TokenVisitor {
  private final boolean detectReturning;
  private LocalStatementType statementType = LocalStatementType.UNKNOWN;
  private ParserState parserState = ParserState.START;
+ private Token schemaToken;
  private Token tableNameToken;
  private ReturningClauseDetector returningClauseDetector;
 
@@ -105,10 +104,13 @@ public void visitToken(Token token, VisitorRegistrar visitorRegistrar) {
  if (parserState.isFinalState()) {
  // We're not interested anymore
  visitorRegistrar.removeVisitor(this);
- } else if (parserState == ParserState.FIND_RETURNING) {
- // We're not interested anymore
- visitorRegistrar.removeVisitor(this);
- if (detectReturning) {
+ } else if (parserState == ParserState.FIND_RETURNING
+ || parserState == ParserState.FIND_SCHEMA_SEPARATOR_OR_RETURNING) {
+ if (parserState == ParserState.FIND_RETURNING) {
+ // We're not interested anymore
+ visitorRegistrar.removeVisitor(this);
+ }
+ if (detectReturning && returningClauseDetector == null) {
  // Use ReturningClauseDetector to handle detection
  returningClauseDetector = new ReturningClauseDetector();
  visitorRegistrar.addVisitor(returningClauseDetector);
@@ -124,8 +126,7 @@ public void complete(VisitorRegistrar visitorRegistrar) {
  }
 
  public StatementIdentification toStatementIdentification() {
- return new StatementIdentification(statementType, tableNameToken != null ? tableNameToken.text() : null,
- returningClauseDetected());
+ return new StatementIdentification(statementType, schemaToken, tableNameToken, returningClauseDetected());
  }
 
  boolean returningClauseDetected() {
@@ -139,6 +140,10 @@ public LocalStatementType getStatementType() {
  return statementType;
  }
 
+ Token getSchemaToken() {
+ return schemaToken;
+ }
+
  Token getTableNameToken() {
  return tableNameToken;
  }
@@ -151,6 +156,10 @@ private void updateStatementType(LocalStatementType statementType) {
  }
  }
 
+ private void setSchemaToken(Token schemaToken) {
+ this.schemaToken = schemaToken;
+ }
+
  private void setTableNameToken(Token tableNameToken) {
  this.tableNameToken = tableNameToken;
  }
@@ -213,12 +222,46 @@ ParserState next(Token token, StatementDetector detector) {
  },
  // Shared by UPDATE, DELETE and MERGE
  DML_TARGET {
+ @Override
+ ParserState next(Token token, StatementDetector detector) {
+ if (token.isValidIdentifier()) {
+ detector.setTableNameToken(token);
+ return DML_SCHEMA_SEPARATOR_OR_POSSIBLE_ALIAS;
+ }
+ return forceOther(detector);
+ }
+ },
+ // Shared by UPDATE, DELETE and MERGE
+ DML_SCHEMA_SEPARATOR_OR_POSSIBLE_ALIAS {
+ @Override
+ ParserState next(Token token, StatementDetector detector) {
+ if (token instanceof PeriodToken) {
+ // What was detected as table, is actually the schema
+ detector.setSchemaToken(detector.getTableNameToken());
+ detector.setTableNameToken(null);
+ return DML_SCHEMA_QUALIFIED_TABLE_NAME;
+ } else if (token.isValidIdentifier()) {
+ // either alias or possibly returning clause
+ return FIND_RETURNING;
+ } else if (token instanceof ReservedToken) {
+ if (token.equalsIgnoreCase("AS")) {
+ return DML_ALIAS;
+ }
+ return FIND_RETURNING;
+ }
+ // Unexpected or invalid token at this point
+ return forceOther(detector);
+ }
+ },
+ // Shared by UPDATE, DELETE and MERGE
+ DML_SCHEMA_QUALIFIED_TABLE_NAME {
  @Override
  ParserState next(Token token, StatementDetector detector) {
  if (token.isValidIdentifier()) {
  detector.setTableNameToken(token);
  return DML_POSSIBLE_ALIAS;
  }
+ // Unexpected or invalid token at this point
  return forceOther(detector);
  }
  },
@@ -263,7 +306,7 @@ ParserState next(Token token, StatementDetector detector) {
  ParserState next(Token token, StatementDetector detector) {
  if (token.isValidIdentifier()) {
  detector.setTableNameToken(token);
- return FIND_RETURNING;
+ return FIND_SCHEMA_SEPARATOR_OR_RETURNING;
  }
  // Syntax error
  return forceOther(detector);
@@ -279,6 +322,29 @@ ParserState next(Token token, StatementDetector detector) {
  return forceOther(detector);
  }
  },
+ FIND_SCHEMA_SEPARATOR_OR_RETURNING {
+ @Override
+ ParserState next(Token token, StatementDetector detector) {
+ if (token instanceof PeriodToken) {
+ detector.setSchemaToken(detector.getTableNameToken());
+ detector.setTableNameToken(null);
+ return FIND_SCHEMA_QUALIFIED_TABLE_OR_RETURNING;
+ } else {
+ return FIND_RETURNING;
+ }
+ }
+ },
+ FIND_SCHEMA_QUALIFIED_TABLE_OR_RETURNING {
+ @Override
+ ParserState next(Token token, StatementDetector detector) {
+ if (token.isValidIdentifier()) {
+ detector.setTableNameToken(token);
+ return FIND_RETURNING;
+ }
+ // Syntax error
+ return forceOther(detector);
+ }
+ },
  // finding itself is offloaded to ReturningClauseDetector
  FIND_RETURNING,
  COMMIT_ROLLBACK {

src/main/org/firebirdsql/jaybird/parser/StatementIdentification.java

@@ -1,8 +1,12 @@
-// SPDX-FileCopyrightText: Copyright 2021-2022 Mark Rotteveel
+// SPDX-FileCopyrightText: Copyright 2021-2025 Mark Rotteveel
 // SPDX-License-Identifier: LGPL-2.1-or-later
 package org.firebirdsql.jaybird.parser;
 
 import org.firebirdsql.util.InternalApi;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+import java.util.Locale;
 
 import static java.util.Objects.requireNonNull;
 
@@ -13,32 +17,74 @@
  * @since 5
  */
 @InternalApi
+@NullMarked
 public final class StatementIdentification {
 
  private final LocalStatementType statementType;
- private final String tableName;
+ private final @Nullable String schema;
+ private final @Nullable String tableName;
  private final boolean returningClauseDetected;
 
- StatementIdentification(LocalStatementType statementType, String tableName, boolean returningClauseDetected) {
+ StatementIdentification(LocalStatementType statementType, @Nullable Token schema, @Nullable Token tableName,
+ boolean returningClauseDetected) {
  this.statementType = requireNonNull(statementType, "statementType");
- this.tableName = tableName;
+ this.schema = normalizeObjectName(schema);
+ this.tableName = normalizeObjectName(tableName);
  this.returningClauseDetected = returningClauseDetected;
  }
 
  public LocalStatementType getStatementType() {
  return statementType;
  }
 
+ /**
+ * Schema, if this is a DML statement (other than {@code SELECT}), and if the table is qualified.
+ * <p>
+ * It reports the name normalized to its metadata storage representation.
+ * </p>
+ *
+ * @return Schema, {@code null} if the table was not qualified, or for {@code SELECT} and other non-DML statements
+ */
+ public @Nullable String getSchema() {
+ return schema;
+ }
+
  /**
  * Table name, if this is a DML statement (other than {@code SELECT}).
+ * <p>
+ * It reports the name normalized to its metadata storage representation.
+ * </p>
  *
  * @return Table name, {@code null} for {@code SELECT} and other non-DML statements
  */
- public String getTableName() {
+ public @Nullable String getTableName() {
  return tableName;
  }
 
  public boolean returningClauseDetected() {
  return returningClauseDetected;
  }
+
+ /**
+ * Normalizes an object name from the parser to its storage representation.
+ * <p>
+ * Unquoted identifiers are uppercased, and quoted identifiers are returned with the quotes stripped and doubled
+ * double quotes replaced by a single double quote.
+ * </p>
+ *
+ * @param objectToken
+ * token with the object name (can be {@code null})
+ * @return normalized object name, or {@code null} if {@code objectToken} was {@code null}
+ */
+ private static @Nullable String normalizeObjectName(@Nullable Token objectToken) {
+ if (objectToken == null) return null;
+ String objectName = objectToken.text().trim();
+ if (objectName.length() > 2
+ && objectName.charAt(0) == '"'
+ && objectName.charAt(objectName.length() - 1) == '"') {
+ return objectName.substring(1, objectName.length() - 1).replace("\"\"", "\"");
+ }
+ return objectName.toUpperCase(Locale.ROOT);
+ }
+
 }

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

@@ -1258,6 +1258,29 @@ private GetTables createGetTablesInstance() {
  return GetTables.create(getDbMetadataMediator());
  }
 
+ @Override
+ public Optional<String> findTableSchema(String tableName) throws SQLException {
+ if (!supportsSchemasInDataManipulation()) return Optional.of("");
+ final String findSchema = """
+ with SEARCH_PATH as (
+ select row_number() over() as PRIO, NAME as SCHEMA_NAME
+ from SYSTEM.RDB$SQL.PARSE_UNQUALIFIED_NAMES(rdb$get_context('SYSTEM', 'SEARCH_PATH'))
+ )
+ select r.RDB$SCHEMA_NAME
+ from RDB$RELATIONS as r
+ inner join SEARCH_PATH s on r.RDB$SCHEMA_NAME = s.SCHEMA_NAME and r.RDB$RELATION_NAME = ?
+ order by s.PRIO
+ fetch first row only""";
+
+ var metadataQuery = new DbMetadataMediator.MetadataQuery(findSchema, List.of(tableName));
+ try (ResultSet rs = getDbMetadataMediator().performMetaDataQuery(metadataQuery)) {
+ if (rs.next()) {
+ return Optional.of(rs.getString(1));
+ }
+ return Optional.empty();
+ }
+ }
+
  @Override
  public ResultSet getSchemas() throws SQLException {
  return getSchemas(null, null);