UseStorageAPI
Specifies whether to use the Google BigQuery Storage API for bulk data reads instead of the standard REST API.
Data Type
bool
Default Value
true
Remarks
When this property is set to true, the server uses the Google BigQuery Storage API, which is optimized for high-throughput, low-latency data access.
Depending on the complexity of the query, the server chooses one of two execution paths:
- Direct execution via the Storage API is used for simple queries that meet all of the following conditions:
- Read all columns
- Reference only one table
- Contain no clauses other than LIMIT
- Query jobs whose results are read using the Storage API are used for all other queries. The server submits a query job, stores the result in a temporary table, and uses the Storage API to read the result.
The Storage API typically offers better performance than the REST API but:
- Requires additional OAuth scopes when using a custom OAuth app
- Uses the StoragePageSize property instead of PageSize
If this property is set to false, the server uses the Google BigQuery REST API, which:
- Requires no extra permissions
- Uses standard pricing
- Is slower and less efficient for large result sets
Keep this property enabled for faster and more efficient data access, especially when working with large datasets. Disable it only if you require simpler authentication or need to reduce dependency on the Storage API.