googleapis / googleapis/google-cloud-java

[bigquery-jdbc] Expose dry-run / query cost estimation API

Open
#14,264 0 comments 1 reaction 1 assignee Claimed by @logachev View on GitHub
Dominant language
Java
Stars
2.1k
Forks
1.2k
Avg merge
1d 23h
Merged PRs (30d)
154

Description

### Problem

BigQuery clients often need to estimate the amount of data a query will process **before executing it**, because BigQuery billing depends on bytes processed.

The BigQuery API supports this through dry runs and returns `totalBytesProcessed`. The Java BigQuery client also exposes this capability, including `Connection.dryRun(String)` / `BigQueryDryRunResult`.

However, `google-cloud-bigquery-jdbc` does not currently expose an equivalent public API through `BigQueryConnection` or `BigQueryStatement`.

This prevents JDBC-based database tools such as DataGrip from providing the same pre-execution cost information that the BigQuery Console provides.

### Requested API

It would be useful to expose dry-run/query estimation as a BigQuery-specific JDBC extension, for example through an unwrapped `BigQueryConnection` or `BigQueryStatement`:

```java
BigQueryStatement statement =
jdbcStatement.unwrap(BigQueryStatement.class);

BigQueryDryRunResult result = statement.dryRun(sql);
long bytes = result.getTotalBytesProcessed();
```

The exact API shape is not important; the main requirement is to perform the dry run using the **existing JDBC connection configuration and authentication**.

Ideally it should preserve:

* authentication/credentials
* project
* location
* default dataset
* session configuration
* prepared-statement parameters, where applicable

### Motivation

For database IDEs and other JDBC tools, this would allow:

> This query will process approximately 1.8 TB.

to be shown before execution, optionally allowing clients to warn users about unexpectedly expensive queries.

`MaximumBytesBilled` is useful as a hard safety limit, but it does not expose the estimated number of bytes to the JDBC client before execution.

The underlying BigQuery APIs already provide dry-run estimation, so this request is specifically about making that capability accessible through the JDBC driver.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.