Skip to content

fix(bigquery-jdbc): align metadata methods error handling with spec #13793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keshavdandeva merged 7 commits into from
Jul 20, 2026
+92 −59
Merged

fix(bigquery-jdbc): align metadata methods error handling with spec #13793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2f598d6
fix(bigquery-jdbc): align metadata methods error handling with spec
keshavdandeva Jul 16, 2026
ca758ea
add 404 error for broad scans
keshavdandeva Jul 16, 2026
8fb262c
update tests
keshavdandeva Jul 16, 2026
45ae7be
update tests
keshavdandeva Jul 17, 2026
99cbcf0
chore: remove extra param `logger` from `findMatchingBigQueryObjects`
keshavdandeva Jul 20, 2026
05fb9f0
Merge branch 'main' into jdbc/metadata-error-handling
keshavdandeva Jul 20, 2026
bd13c87
Merge branch 'main' into jdbc/metadata-error-handling
keshavdandeva Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 35 additions & 52 deletions ...-bigquery-jdbc/src/main/java/com/google/cloud/bigquery/jdbc/BigQueryDatabaseMetaData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -836,7 +836,7 @@ public ResultSet getProcedures(
(rt) -> rt.getRoutineId().getRoutine(),
procedureNamePattern,
procedureNameRegex,
LOG);
false);
Future<List<Routine>> apiFuture = apiExecutor.submit(apiCallable);
apiFutures.add(apiFuture);
}
Expand Down Expand Up @@ -1138,7 +1138,7 @@ List<RoutineId> listMatchingProcedureIdsFromDatasets(
(rt) -> rt.getRoutineId().getRoutine(),
procedureNamePattern,
procedureNameRegex,
logger);
false);
listRoutineFutures.add(listRoutinesExecutor.submit(listCallable));
}
logger.fine(
Expand Down Expand Up @@ -1637,7 +1637,7 @@ public ResultSet getTables(
(tbl) -> tbl.getTableId().getTable(),
tableNamePattern,
tableNameRegex,
LOG);
false);
Future<List<Table>> apiFuture = apiExecutor.submit(apiCallable);
apiFutures.add(apiFuture);
}
Expand Down Expand Up @@ -1951,7 +1951,7 @@ public ResultSet getColumns(
(tbl) -> tbl.getTableId().getTable(),
tableNamePattern,
tableNameRegex,
LOG);
false);

for (Table table : tablesToScan) {
if (Thread.currentThread().isInterrupted()) {
Expand Down Expand Up @@ -2428,13 +2428,11 @@ public ResultSet getPrimaryKeys(String catalog, String schema, String table) thr
final List<FieldValueList> collectedResults = Collections.synchronizedList(new ArrayList<>());
List<DatasetId> targetDatasets = getTargetDatasets(catalog, schema);

boolean ignoreAccessErrors = (catalog == null);
processTargetTablesConcurrently(
targetDatasets,
table,
collectedResults,
resultSchemaFields,
ignoreAccessErrors,
(bqTable, results, fields) -> {
TableConstraints constraints = bqTable.getTableConstraints();
processPrimaryKey(constraints, bqTable.getTableId(), results, fields);
Expand Down Expand Up @@ -2525,13 +2523,11 @@ public ResultSet getImportedKeys(String catalog, String schema, String table)
final List<FieldValueList> collectedResults = Collections.synchronizedList(new ArrayList<>());
List<DatasetId> targetDatasets = getTargetDatasets(catalog, schema);

boolean ignoreAccessErrors = (catalog == null);
processTargetTablesConcurrently(
targetDatasets,
table,
collectedResults,
resultSchemaFields,
ignoreAccessErrors,
(bqTable, results, fields) -> {
TableConstraints constraints = bqTable.getTableConstraints();
if (constraints == null || constraints.getForeignKeys() == null) {
Expand Down Expand Up @@ -2578,15 +2574,13 @@ public ResultSet getExportedKeys(String catalog, String schema, String table)
// Fallback Path: If catalog or schema is null, fall back to REST API metadata scan.
if (catalog == null || schema == null) {
final List<FieldValueList> collectedResults = Collections.synchronizedList(new ArrayList<>());
List<DatasetId> targetDatasets = getTargetDatasets(catalog, schema);
List<DatasetId> targetDatasets = getTargetDatasets(catalog, null);

boolean ignoreAccessErrors = (catalog == null);
processTargetTablesConcurrently(
targetDatasets,
null,
collectedResults,
resultSchemaFields,
ignoreAccessErrors,
(bqTable, results, fields) -> {
TableConstraints constraints = bqTable.getTableConstraints();
if (constraints == null || constraints.getForeignKeys() == null) {
Expand Down Expand Up @@ -2656,13 +2650,11 @@ public ResultSet getCrossReference(
final List<FieldValueList> collectedResults = Collections.synchronizedList(new ArrayList<>());
List<DatasetId> targetDatasets = getTargetDatasets(foreignCatalog, foreignSchema);

boolean ignoreAccessErrors = (foreignCatalog == null);
processTargetTablesConcurrently(
targetDatasets,
foreignTable,
collectedResults,
resultSchemaFields,
ignoreAccessErrors,
(bqTable, results, fields) -> {
TableConstraints constraints = bqTable.getTableConstraints();
if (constraints == null || constraints.getForeignKeys() == null) {
Expand Down Expand Up @@ -3869,7 +3861,7 @@ public ResultSet getFunctions(String catalog, String schemaPattern, String funct
(rt) -> rt.getRoutineId().getRoutine(),
functionNamePattern,
functionNameRegex,
LOG);
false);
};
Future<List<Routine>> apiFuture = apiExecutor.submit(apiCallable);
apiFutures.add(apiFuture);
Expand Down Expand Up @@ -4220,7 +4212,7 @@ List<RoutineId> listMatchingFunctionIdsFromDatasets(
(rt) -> rt.getRoutineId().getRoutine(),
functionNamePattern,
functionNameRegex,
logger);
false);
listRoutineFutures.add(listRoutinesExecutor.submit(listCallable));
}
logger.fine(
Expand Down Expand Up @@ -4656,7 +4648,7 @@ <T> List<T> findMatchingBigQueryObjects(
Function<T, String> nameExtractor,
String pattern,
Pattern regex,
BigQueryJdbcCustomLogger logger)
boolean throwOn404)
throws InterruptedException {

boolean needsList = needsListing(pattern);
Expand All @@ -4665,30 +4657,29 @@ <T> List<T> findMatchingBigQueryObjects(
try {
Iterable<T> objects;
if (needsList) {
logger.info(
LOG.info(
"Listing all %ss (pattern: %s)...",
objectTypeName, pattern == null ? "<all>" : pattern);
Page<T> firstPage = listAllOperation.get();
objects = firstPage.iterateAll();
logger.fine(
"Retrieved initial %s list, iterating & filtering if needed...", objectTypeName);
LOG.fine("Retrieved initial %s list, iterating & filtering if needed...", objectTypeName);

} else {
logger.info("Getting specific %s: '%s'", objectTypeName, pattern);
LOG.info("Getting specific %s: '%s'", objectTypeName, pattern);
T specificObject = getSpecificOperation.apply(pattern);
objects =
(specificObject == null)
? Collections.<T>emptyList()
: Collections.singletonList(specificObject);
if (specificObject == null) {
logger.info("Specific %s not found: '%s'", objectTypeName, pattern);
LOG.info("Specific %s not found: '%s'", objectTypeName, pattern);
}
}

boolean wasListing = needsList;
for (T obj : objects) {
if (Thread.currentThread().isInterrupted()) {
logger.warning("Thread interrupted during " + objectTypeName + " processing loop.");
LOG.warning("Thread interrupted during " + objectTypeName + " processing loop.");
throw new InterruptedException(
"Interrupted during " + objectTypeName + " processing loop");
}
Expand All @@ -4705,20 +4696,21 @@ <T> List<T> findMatchingBigQueryObjects(
}

} catch (BigQueryException e) {
if (!needsList && e.getCode() == 404) {
logger.info("%s '%s' not found (API error 404).", objectTypeName, pattern);
if (e.getCode() == 404 && !throwOn404) {
LOG.info("%s '%s' not found (API error 404).", objectTypeName, pattern);
return Collections.emptyList();
} else {
logger.warning(
LOG.warning(
"BigQueryException finding %ss for pattern '%s': %s (Code: %d)",
objectTypeName, pattern, e.getMessage(), e.getCode());
throw e;
}
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
logger.warning("Interrupted while finding " + objectTypeName + "s.");
LOG.warning("Interrupted while finding " + objectTypeName + "s.");
throw e;
} catch (Exception e) {
logger.severe(
LOG.severe(
"Unexpected exception finding %ss for pattern '%s': %s",
objectTypeName, pattern, e.getMessage());
throw new RuntimeException(e);
Expand Down Expand Up @@ -5022,7 +5014,8 @@ private void signalEndOfData(
}

private List<Dataset> fetchDatasetsForProject(
String project, String schemaPattern, Pattern schemaRegex) throws SQLException {
String project, String schemaPattern, Pattern schemaRegex, boolean throwOn404)
throws SQLException {
try {
List<Dataset> datasets =
findMatchingBigQueryObjects(
Expand All @@ -5032,7 +5025,7 @@ private List<Dataset> fetchDatasetsForProject(
(ds) -> ds.getDatasetId().getDataset(),
schemaPattern,
schemaRegex,
LOG);
throwOn404);
return datasets != null ? datasets : Collections.emptyList();
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
Expand All @@ -5052,9 +5045,11 @@ private List<Dataset> fetchMatchingDatasets(
return Collections.emptyList();
}

boolean isBroadScan = (catalog == null);

// Single project path
if (projects.size() == 1) {
return fetchDatasetsForProject(projects.get(0), schemaPattern, schemaRegex);
return fetchDatasetsForProject(projects.get(0), schemaPattern, schemaRegex, isBroadScan);
}

// Multi-project path
Expand All @@ -5066,7 +5061,8 @@ private List<Dataset> fetchMatchingDatasets(
for (String project : projects) {
Callable<Void> task =
() -> {
List<Dataset> datasets = fetchDatasetsForProject(project, schemaPattern, schemaRegex);
List<Dataset> datasets =
fetchDatasetsForProject(project, schemaPattern, schemaRegex, isBroadScan);
allDatasets.addAll(datasets);
return null;
};
Expand Down Expand Up @@ -5179,18 +5175,17 @@ private void processSingleTable(
String tableName,
List<FieldValueList> collectedResults,
FieldList resultSchemaFields,
boolean ignoreAccessErrors,
TableProcessor processor)
throws SQLException {
Table bqTable;
try {
bqTable =
bigquery.getTable(TableId.of(datasetId.getProject(), datasetId.getDataset(), tableName));
} catch (BigQueryException e) {
if (ignoreAccessErrors && (e.getCode() == 404 || e.getCode() == 403)) {
if (e.getCode() == 404) {
LOG.info(
"Table '%s' or dataset '%s' not found/accessible in project '%s' (API error %d). Skipping.",
tableName, datasetId.getDataset(), datasetId.getProject(), e.getCode());
"Table '%s' or dataset '%s' not found in project '%s' (API error 404). Skipping.",
tableName, datasetId.getDataset(), datasetId.getProject());
bqTable = null;
} else {
throw new SQLException("Error while fetching table metadata: " + e.getMessage(), e);
Expand All @@ -5208,17 +5203,11 @@ private void processTargetTablesConcurrently(
String tableName,
List<FieldValueList> collectedResults,
FieldList resultSchemaFields,
boolean ignoreAccessErrors,
TableProcessor processor)
throws SQLException {
if (targetDatasets.size() == 1 && tableName != null) {
processSingleTable(
targetDatasets.get(0),
tableName,
collectedResults,
resultSchemaFields,
ignoreAccessErrors,
processor);
targetDatasets.get(0), tableName, collectedResults, resultSchemaFields, processor);
Comment thread
keshavdandeva marked this conversation as resolved.
return;
}

Expand All @@ -5232,12 +5221,7 @@ private void processTargetTablesConcurrently(
tasks.add(
() -> {
processSingleTable(
datasetId,
tableName,
collectedResults,
resultSchemaFields,
ignoreAccessErrors,
processor);
datasetId, tableName, collectedResults, resultSchemaFields, processor);
Comment thread
keshavdandeva marked this conversation as resolved.
return null;
});
continue;
Expand All @@ -5261,16 +5245,15 @@ private void processTargetTablesConcurrently(
table.getTableId().getTable(),
collectedResults,
resultSchemaFields,
ignoreAccessErrors,
processor);
return null;
});
}
} catch (BigQueryException e) {
if (ignoreAccessErrors && (e.getCode() == 404 || e.getCode() == 403)) {
if (e.getCode() == 404) {
LOG.info(
"Dataset '%s' not found/accessible in project '%s' (API error %d). Skipping.",
datasetId.getDataset(), datasetId.getProject(), e.getCode());
"Dataset '%s' not found in project '%s' (API error 404). Skipping.",
datasetId.getDataset(), datasetId.getProject());
continue;
}
throw new SQLException("Error while listing tables: " + e.getMessage(), e);
Expand Down
57 changes: 54 additions & 3 deletions ...query-jdbc/src/test/java/com/google/cloud/bigquery/jdbc/BigQueryDatabaseMetaDataTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1028,7 +1028,7 @@ public void testFindMatchingBigQueryObjects_Routines_ListWithPattern() throws Ex
(rt) -> rt.getRoutineId().getRoutine(),
pattern,
regex,
dbMetadata.LOG);
false);
Comment thread
keshavdandeva marked this conversation as resolved.

verify(bigqueryClient, times(1))
.listRoutines(eq(datasetId), any(BigQuery.RoutineListOption[].class));
Expand Down Expand Up @@ -1070,7 +1070,7 @@ public void testFindMatchingBigQueryObjects_Routines_ListNoPattern() throws Exce
(rt) -> rt.getRoutineId().getRoutine(),
pattern,
regex,
dbMetadata.LOG);
false);

verify(bigqueryClient, times(1))
.listRoutines(eq(datasetId), any(BigQuery.RoutineListOption[].class));
Expand Down Expand Up @@ -1105,7 +1105,7 @@ public void testFindMatchingBigQueryObjects_Routines_GetSpecific() throws Except
(rt) -> rt.getRoutineId().getRoutine(),
procNameExact,
regex,
dbMetadata.LOG);
false);

verify(bigqueryClient, times(1)).getRoutine(eq(routineId));
verify(bigqueryClient, never())
Expand All @@ -1117,6 +1117,57 @@ public void testFindMatchingBigQueryObjects_Routines_GetSpecific() throws Except
assertSame(mockRoutine, resultList.get(0));
}

private List<Table> invokeFindMatchingObjectsWithException(
BigQueryException bqe, String pattern, boolean throwOn404) throws Exception {
return dbMetadata.findMatchingBigQueryObjects(
"Table",
() -> {
throw bqe;
},
(name) -> {
throw bqe;
},
(table) -> "name",
pattern,
dbMetadata.compileSqlLikePattern(pattern),
throwOn404);
}

@Test
public void testFindMatchingBigQueryObjects_Swallows404_TargetedScan() throws Exception {
List<Table> results =
invokeFindMatchingObjectsWithException(
new BigQueryException(404, "Not Found"), "exact_match", false);
assertTrue(results.isEmpty());
}

@Test
public void testFindMatchingBigQueryObjects_Throws404_BroadScan() {
assertThrows(
BigQueryException.class,
() ->
invokeFindMatchingObjectsWithException(
new BigQueryException(404, "Not Found"), "%", true));
}

@Test
public void testFindMatchingBigQueryObjects_Throws403_BroadScan() {
assertThrows(
BigQueryException.class,
() ->
invokeFindMatchingObjectsWithException(
new BigQueryException(403, "Access Denied"), "%", true));
}

@Test
public void testFindMatchingBigQueryObjects_Throws403_TargetedScan() {
assertThrows(
BigQueryException.class,
() ->
invokeFindMatchingObjectsWithException(
new BigQueryException(403, "Access Denied"), "exact_match", false));
}

@Test
public void testDefineGetProcedureColumnsSchema() {
Schema schema = dbMetadata.defineGetProcedureColumnsSchema();
Expand Down
Loading
Loading