Skip to content

feat(bigquery-jdbc): Migrate getImportedKeys and getCrossReference to BQ API#13692

Merged
keshavdandeva merged 12 commits into
mainfrom
jdbc/getImportedKeys
Jul 9, 2026
Merged

feat(bigquery-jdbc): Migrate getImportedKeys and getCrossReference to BQ API#13692
keshavdandeva merged 12 commits into
mainfrom
jdbc/getImportedKeys

Conversation

@keshavdandeva

Copy link
Copy Markdown
Contributor

b/532249777

This PR migrates the getImportedKeys and getCrossReference JDBC metadata methods in BigQueryDatabaseMetaData to retrieve constraints natively via the Google Cloud Java Client API instead of running legacy raw SQL files on BigQuery.

Changes

API-based Implementations

  • Migrated getImportedKeys(...) to fetch and scan foreign keys from standard table definitions.
  • Migrated getCrossReference(...) to matching parent and foreign table references using client-side definitions.
  • Utilized the shared parallel table processor utilities (processTargetTablesConcurrently(...) and processSingleTable(...)) to run dataset scans concurrently.

Sorting & Correctness

  • Separated sorting behavior according to the JDBC specification:
    • getImportedKeys is sorted by parent table: PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, KEY_SEQ. Introduced definePkTableSortComparator for this.
    • getCrossReference (and future getExportedKeys) is sorted by child table: FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, KEY_SEQ. Uses defineFkTableSortComparator.
  • Introduced a private helper matchesOrNullWildcard(...) to simplify and clean up catalog/schema bounds comparisons.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Warning

Gemini encountered an error creating the review. You can try again by commenting /gemini review.

@keshavdandeva

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Warning

Gemini encountered an error creating the review. You can try again by commenting /gemini review.

@keshavdandeva keshavdandeva marked this pull request as ready for review July 8, 2026 01:04
@keshavdandeva keshavdandeva requested review from a team as code owners July 8, 2026 01:04
Base automatically changed from jdbc/get-primary-keys to main July 8, 2026 20:11
@keshavdandeva

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request refactors BigQueryDatabaseMetaData to retrieve imported keys and cross-references using Java API calls (bqTable.getTableConstraints()) instead of executing SQL queries from external files. This change removes the need for DatabaseMetaData_GetImportedKeys.sql and DatabaseMetaData_GetCrossReference.sql files, and simplifies constraint processing. There are no review comments, so I have no feedback to provide.

@logachev logachev left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approving assuming these methods have existing unittests/integration tests

b/532245343

This PR migrates `BigQueryDatabaseMetaData.getExportedKeys()` from
legacy `INFORMATION_SCHEMA` SQL queries to the native BigQuery Java SDK.
This leverages the `TableConstraints` metadata directly, aligning it
with the recent migrations of `getPrimaryKeys` and `getImportedKeys`.

**Key Changes:**
* **API Migration**: Rewrote `getExportedKeys` to use `TableConstraints`
fetched via the native SDK, eliminating the need for
`DatabaseMetaData_GetExportedKeys.sql`.
* **Concurrent Scanning**: Upgraded `processTargetTablesConcurrently` to
dynamically list and concurrently scan all tables across target datasets
when a parent table isn't explicitly provided.
* **Sorting Compliance**: Added `defineFkTableSortComparator` to
correctly sort result sets by `FKTABLE_CAT`, `FKTABLE_SCHEM`,
`FKTABLE_NAME`, and `KEY_SEQ` as strictly required by the JDBC spec.
* **Code Cleanup**: Removed obsolete SQL constants, `.sql` resource
files, and dead helper methods (`readSqlFromFile`,
`replaceSqlParameters`).
*   **Testing**: Added new integration test `testGetExportedKeys`
@keshavdandeva keshavdandeva enabled auto-merge (squash) July 9, 2026 13:23
@keshavdandeva keshavdandeva merged commit 082b046 into main Jul 9, 2026
204 checks passed
@keshavdandeva keshavdandeva deleted the jdbc/getImportedKeys branch July 9, 2026 13:46
keshavdandeva added a commit that referenced this pull request Jul 9, 2026
…` to BQ API (#13692)

b/532249777

This PR migrates the `getImportedKeys` and `getCrossReference` JDBC
metadata methods in `BigQueryDatabaseMetaData` to retrieve constraints
natively via the Google Cloud Java Client API instead of running legacy
raw SQL files on BigQuery.

## Changes

### **API-based Implementations**
- Migrated `getImportedKeys(...)` to fetch and scan foreign keys from
standard table definitions.
- Migrated `getCrossReference(...)` to matching parent and foreign table
references using client-side definitions.
- Utilized the shared parallel table processor utilities
(`processTargetTablesConcurrently(...)` and `processSingleTable(...)`)
to run dataset scans concurrently.

### **Sorting & Correctness**
- Separated sorting behavior according to the JDBC specification:
- `getImportedKeys` is sorted by parent table: `PKTABLE_CAT,
PKTABLE_SCHEM, PKTABLE_NAME, KEY_SEQ`. Introduced
`definePkTableSortComparator` for this.
- `getCrossReference` (and future `getExportedKeys`) is sorted by child
table: `FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, KEY_SEQ`. Uses
`defineFkTableSortComparator`.
- Introduced a private helper `matchesOrNullWildcard(...)` to simplify
and clean up catalog/schema bounds comparisons.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants