High-Throughput API

The High-Throughput API is a new feature of the Simba Google BigQuery ODBC Connector. This API enables the connector to leverage the BigQuery Storage API, allowing higher data throughput than the standard REST API. With this API, the connector can handle large result sets more efficiently. For more information about the Storage API, see "BigQuery Storage API Overview" in the Google BigQuery documentation: https://cloud.google.com/bigquery/docs/reference/storage/.

The connector checks the number of rows in an incoming result set table and extrapolates the number of pages needed to retrieve all the results. If the number of table rows and the ratio of rows to pages both exceed the defined thresholds, the connector uses the BigQuery Storage API. Should the connector encounters any issues with initializing the storage API for retrieval, it falls back to using the standard REST API, unless this is a permissions issue.

You can customize the thresholds for using the BigQuery Storage API. For information about the configuration options used to determine when the API is used, see the following:

Requirements

Before you can use the High-Throughput API, you must make certain that your system meets the following requirements:

  • The BigQuery project that you are querying must have the BigQuery Storage API enabled. For more information, see "Enabling the API" in the Google BigQuery documentation: https://cloud.google.com/bigquery/docs/reference/storage/#enabling_the_api.
    • Important:

    Important:

    Pricing for the BigQuery Storage API is different than pricing for the standard API. For more information, see "BigQuery Storage API Pricing" in the Google BigQuery documentation: https://cloud.google.com/bigquery/pricing#storage-api.

  • The connector must not be configured to use the trust store, that is, the Use System Trust Store check box must not be selected or the UseSystemTrustStore property must not be set to 1.
  • To enable the High-Throughput API for use with large result sets, the Enable High-Throughput API check box must be selected or the EnableHTAPI property must be set to 1.

The INTERVAL data type is not supported on the Read API. When retrieving data from a column of the INTERVAL type, the connector returns an error. To enable the connector to fallback to the REST API, set UnsupportedHTAPIFallback to 1.

Related topics