Configuring the High-Throughput API

You can configure the connector to use the High-Throughput API to handle large result sets more efficiently. For more information about the High-Throughput API, see High-Throughput API.

To configure the High-Throughput API:

  1. Make sure that your Google BigQuery project has the Storage API enabled. 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/.
  2. To access the DSN that you want to configure the High-Throughput API for, open the ODBC Data Source Administrator where you created the DSN, then select the DSN, then click Configure.
  3. Choose one:
    • To verify the server using the trusted CA certificates from a specific .pem file, specify the full path to the file in the Trusted Certificates field and leave the Use System Trust Store check box cleared.
    • Or, to use the trusted CA certificates .pem file that is installed with the connector, leave the default value in the Trusted Certificates field, and leave the Use System Trust Store check box cleared.
    Important:

    Important:

    Do not select the Use System Trust Store check box. The High-Throughput API is not compatible with the Windows Trust Store.

  4. Click Advanced Options.
  5. If you are using Legacy SQL (the Language Dialect drop-down list is set to Legacy SQL), then make sure that the Allow Large Result Sets check box is selected.
  6. To specify the dataset that stores temporary tables for large result sets and result sets returned by the High-Throughput API, do one of the following:
    • To use the default dataset with the ID _bqodbc_temp_tables, select the Use Default _bqodbc_temp_tables Large Results Dataset check box.
    • Or, to specify a different dataset, clear the Use Default _bqodbc_temp_tables Large Results Dataset check box and, in the Dataset Name For Large Result Sets field, type the ID of the BigQuery dataset that you want to use.

    Note:

    • If the dataset does not exist and the data store specifies the US region, the connector creates the dataset.
    • These options are only available if the connector is configured to use large result sets.
  7. Optionally, if you want to use large results and query the data with the HTAPI, select the Allow High-Throughput API for Large Results queries check box.
  8. In the Activation Threshold for High-Throughput API field, specify the minimum total pages required to activate reading through the High-Throughput API.
  9. To save your settings and close the Advanced Options dialog box, click OK.

The connector now uses the BigQuery High-Throughput API instead of the REST API for requests where:

  • the number of pages in the results exceeds the Activation Threshold for High-Throughput API value.
  • And, if the request uses large result dataset, the Allow High-Throughput API for Large Results Dataset property is set.

Related topics