Google BigQuery Connector for C# Read / write Google BigQuery data inside your app without coding using easy to use high performance API Connector In this article you will learn how to quickly and efficiently integrate Google BigQuery data in C#. We will use high-performance Google BigQuery Connector to easily connect to Google BigQuery and then access the data inside C#. Let's follow the steps below to see how we can accomplish that! Download Documentation Google BigQuery Connector for C# is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few.

Connect to Google BigQuery in other apps Connect to Google BigQuery in SSIS Connect to Google BigQuery in SQL Server Connect to Google BigQuery in Power BI Connect to Google BigQuery in SSRS Connect to Google BigQuery in Informatica Connect to Google BigQuery in MS Access Connect to Google BigQuery in MS Excel Connect to Google BigQuery in SSAS Connect to Google BigQuery in Python Connect to Google BigQuery in JAVA Connect to Google BigQuery in Tableau Connect to Google BigQuery in SAP Crystal Reports Connect to Google BigQuery in Azure Data Factory (Pipeline) Connect to Google BigQuery in Azure Data Factory (SSIS) Connect to Google BigQuery in Talend Studio Connect to Google BigQuery in UiPath Connect to Google BigQuery in PowerShell Connect to Google BigQuery in ODBC

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Google BigQuery using C# we first need to create a DSN (Data Source) which will access data from Google BigQuery. We will later be able to read data using C#. Perform these steps:

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. Create a User data source (User DSN) based on ZappySys API Driver

   ZappySys API Driver

   
   • Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
   • Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Google BigQuery" from the list of Popular Connectors. If "Google BigQuery" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

   GoogleBigqueryDSN

   Google BigQuery

   

5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    User Account [OAuth]

   User accounts represent a developer, administrator, or any other person who interacts with Google APIs and services. User accounts are managed as Google Accounts, either with Google Workspace or Cloud Identity. They can also be user accounts that are managed by a third-party identity provider and federated with Workforce Identity Federation. [API reference]

   Steps how to get and use Google BigQuery credentials
   

   Follow these steps on how to create Client Credentials (User Account principle) to authenticate and access BigQuery API in SSIS package or ODBC data source:

   WARNING: If you are planning to automate processes, we recommend that you use a Service Account authentication method. In case, you still need to use User Account, then make sure you use a system/generic account (e.g. automation@my-company.com). When you use a personal account which is tied to a specific employee profile and that employee leaves the company, the token may become invalid and any automated processes using that token will start to fail.

   Step-1: Create project

   This step is optional, if you already have a project in Google Cloud and can use it. However, if you don't, proceed with these simple steps to create one:

   1. First of all, go to Google API Console.

   2. Then click Select a project button and then click NEW PROJECT button:

      

   3. Name your project and click CREATE button:

      

   4. Wait until the project is created:

      
   5. Done! Let's proceed to the next step.

   Step-2: Enable Google Cloud APIs

   In this step we will enable BigQuery API and Cloud Resource Manager API:

   1. Select your project on the top bar:

      

   2. Then click the "hamburger" icon on the top left and access APIs & Services:

      

   3. Now let's enable several APIs by clicking ENABLE APIS AND SERVICES button:

      

   4. In the search bar search for bigquery api and then locate and select BigQuery API:

      

   5. If BigQuery API is not enabled, enable it:

      

   6. Then repeat the step and enable Cloud Resource Manager API as well:

      
   7. Done! Let's proceed to the next step.

   Step-3: Create OAuth application

   1. First of all, click the "hamburger" icon on the top left and then hit VIEW ALL PRODUCTS:

      

   2. Then access Google Auth Platform to start creating an OAuth application:

      

   3. Start by pressing GET STARTED button:

      

   4. Next, continue by filling in App name and User support email fields:

      

   5. Choose Internal option, if it's enabled, otherwise select External:

      

   6. Optional step if you used Internal option in the previous step. Nevertheless, if you had to use External option, then click ADD USERS to add a user:

      

   7. Then add your contact Email address:

      

   8. Finally, check the checkbox and click CREATE button:

      
   9. Done! Let's create Client Credentials in the next step.

   Step-4: Create Client Credentials

   1. In Google Auth Platform, select Clients menu item and click CREATE CLIENT button:

      

   2. Choose Desktop app as Application type and name your credentials:

      

   3. Continue by opening the created credentials:

      

   4. Finally, copy Client ID and Client secret for the later step:

      

   5. Done! We have all the data needed for authentication, let's proceed to the last step!

   Step-5: Configure connection

   1. Now go to SSIS package or ODBC data source and use previously copied values in User Account authentication configuration:

      • In the ClientId field paste the Client ID value.
      • In the ClientSecret field paste the Client secret value.

   2. Press Generate Token button to generate Access and Refresh Tokens.

   3. Then choose ProjectId from the drop down menu.

   4. Continue by choosing DatasetId from the drop down menu.

   5. Finally, click Test Connection to confirm the connection is working.

   6. Done! Now you are ready to use Google BigQuery Connector!

   Fill in all required parameters and set optional parameters if needed:

   GoogleBigqueryDSN

   Google BigQuery

   User Account [OAuth]

   https://www.googleapis.com/bigquery/v2

   Required Parameters
   UseCustomApp	Fill-in the parameter...
   ProjectId (Choose after [Generate Token] clicked)	Fill-in the parameter...
   DatasetId (Choose after [Generate Token] clicked and ProjectId selected)	Fill-in the parameter...
   Optional Parameters
   ClientId
   ClientSecret
   Scope	https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigquery.insertdata https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429|503
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   Job Location
   Redirect URL (Only for Web App)

   

    Service Account [OAuth]

   Service accounts are accounts that do not represent a human user. They provide a way to manage authentication and authorization when a human is not directly involved, such as when an application needs to access Google Cloud resources. Service accounts are managed by IAM. [API reference]

   Steps how to get and use Google BigQuery credentials
   

   Follow these steps on how to create Service Account to authenticate and access BigQuery API in SSIS package or ODBC data source:

   Step-1: Create project

   This step is optional, if you already have a project in Google Cloud and can use it. However, if you don't, proceed with these simple steps to create one:

   1. First of all, go to Google API Console.

   2. Then click Select a project button and then click NEW PROJECT button:

      

   3. Name your project and click CREATE button:

      

   4. Wait until the project is created:

      
   5. Done! Let's proceed to the next step.

   Step-2: Enable Google Cloud APIs

   In this step we will enable BigQuery API and Cloud Resource Manager API:

   1. Select your project on the top bar:

      

   2. Then click the "hamburger" icon on the top left and access APIs & Services:

      

   3. Now let's enable several APIs by clicking ENABLE APIS AND SERVICES button:

      

   4. In the search bar search for bigquery api and then locate and select BigQuery API:

      

   5. If BigQuery API is not enabled, enable it:

      

   6. Then repeat the step and enable Cloud Resource Manager API as well:

      
   7. Done! Let's proceed to the next step and create a service account.

   Step-3: Create Service Account

   Use the steps below to create a Service Account in Google Cloud:

   1. First of all, go to IAM & Admin in Google Cloud console:

      

   2. Once you do that, click Service Accounts on the left side and click CREATE SERVICE ACCOUNT button:

      

   3. Then name your service account and click CREATE AND CONTINUE button:

      

   4. Continue by clicking Select a role dropdown and start granting service account BigQuery Admin and Project Viewer roles:

      

   5. Find BigQuery group on the left and then click on BigQuery Admin role on the right:

      

   6. Then click ADD ANOTHER ROLE button, find Project group and select Viewer role:

      

   7. Finish adding roles by clicking CONTINUE button:

      
      You can always add or modify permissions later in IAM & Admin.

   8. Finally, in the last step, just click button DONE:

      

   9. Done! We are ready to add a Key to this service account in the next step.

   Step-4: Add Key to Service Account

   We are ready to add a Key (JSON or P12 key file) to the created Service Account:

   1. In Service Accounts open newly created service account:

      

   2. Next, copy email address of your service account for the later step:

      

   3. Continue by selecting KEYS tab, then press ADD KEY dropdown, and click Create new key menu item:

      

   4. Finally, select JSON (Engine v19+) or P12 option and hit CREATE button:

      
   5. Key file downloads into your machine. We have all the data needed for authentication, let's proceed to the last step!

   Step-5: Configure connection

   1. Now go to SSIS package or ODBC data source and configure these fields in Service Account authentication configuration:

      • In the Service Account Email field paste the service account Email address value you copied in the previous step.
      • In the Service Account Private Key Path (i.e. *.json OR *.p12) field use downloaded certificate's file path.
   2. Done! Now you are ready to use Google BigQuery Connector!

   Fill in all required parameters and set optional parameters if needed:

   GoogleBigqueryDSN

   Google BigQuery

   Service Account [OAuth]

   https://www.googleapis.com/bigquery/v2

   Required Parameters
   Service Account Email	Fill-in the parameter...
   Service Account Private Key Path (i.e. *.json OR *.p12)	Fill-in the parameter...
   ProjectId	Fill-in the parameter...
   DatasetId (Choose after ProjectId)	Fill-in the parameter...
   Optional Parameters
   Scope	https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigquery.insertdata https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   Job Location
   Impersonate As (Enter Email Id)

   

6. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

   

   ZappySys API Driver - Google BigQuery

   Read / write Google BigQuery data inside your app without coding using easy to use high performance API Connector

   GoogleBigqueryDSN

   

7. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in C# to retrieve data from Google BigQuery. Hit OK button to use this query in the next step.

   #DirectSQL SELECT * FROM bigquery-public-data.samples.wikipedia LIMIT 1000 /* try your own dataset or Some FREE dataset like nyc-tlc.yellow.trips -- 3 parts ([Project.]Dataset.Table) */

   
   Some parameters configured in this window will be passed to the Google BigQuery API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

8. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in C#:

   

   ZappySys API Driver - Google BigQuery

   Read / write Google BigQuery data inside your app without coding using easy to use high performance API Connector

   GoogleBigqueryDSN

   #DirectSQL SELECT * FROM bigquery-public-data.samples.wikipedia LIMIT 1000 /* try your own dataset or Some FREE dataset like nyc-tlc.yellow.trips -- 3 parts ([Project.]Dataset.Table) */

   
   You can also access data quickly from the tables dropdown by selecting <Select table>.
   A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Google BigQuery API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Google BigQuery servers).

9. Click OK to finish creating the data source.

Video Tutorial

Read data in C#

Using ODBC DSN

1. Create a new Console project and use this code to read the data:
   

   "GoogleBigqueryDSN";

   

2. Press F5 to run the code and read the data:
   

3. Here is the code in text format:

   using System;
   using System.Data.Odbc;
   
   namespace ConsoleApp {
       class Program {
           static void Main() {
               var dsn = "GoogleBigqueryDSN";
               using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn)))
               {
                   conn.Open();
                   var cmd = new OdbcCommand("SELECT * FROM Products", conn);
                   
                   //Increase the timeout duration from the default 30 seconds, which may be insufficient in certain scenarios
                   cmd.CommandTimeout=600; // 600-Seconds
                   
                   var rdr = cmd.ExecuteReader();
                   while (rdr.Read())
                   {
                       for (int i = 0; i < rdr.FieldCount; i++)
                       {
                               Console.Write("{0}\t", rdr[i]);
                       }
                       Console.WriteLine();
                   }
               }
               Console.ReadKey();
           }
       }
   }
   

Using a full ODBC connection string

If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String:

1. Open ODBC data source configuration and click Copy settings:
   

   ZappySys API Driver - Configuration [Version: 2.0.1.10418]

   ZappySys API Driver - Google BigQuery

   Read / write Google BigQuery data inside your app without coding using easy to use high performance API Connector

   GoogleBigqueryDSN

   
2. The window opens, telling us the connection string was successfully copied to the clipboard:

3. Then in your C# code, pass the connection string as an argument when calling the OdbcConnection object's constructor, for example:

   var connectionString = @"DRIVER={ZappySys API Driver};ServiceUrl=https://www.googleapis.com/bigquery/v2;Provider=GoogleBigQuery;";
   
   using (var conn = new OdbcConnection(connectionString))
   {
       // your code goes here
   }

Limitations of using a full connection string

Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:

1. Open your ODBC data source.
2. Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
3. Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
4. Continue by pasting the copied connection string into a newly created file and save it.
5. Finally, the last step! Just construct a shorter ODBC connection string using this format:

   DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt

6. Our troubles are over! Now you should be able to use this connection string in C# with no problems.

Actions supported by Google BigQuery Connector

Learn how to perform common Google BigQuery actions directly in C# with these how-to guides:

• [Dynamic Endpoint]
• Create Dataset
• Delete Dataset
• Delete Table
• Get Query Schema (From SQL)
• Get Table Schema
• insert_table_data
• List Datasets
• List Projects
• List Tables
• post_[Dynamic Endpoint]
• Read Data using SQL Query -OR- Execute Script (i.e. CREATE, SELECT, INSERT, UPDATE, DELETE)
• Read Table Rows
• Generic Request
• Generic Request (Bulk Write)

Conclusion

In this article we showed you how to connect to Google BigQuery in C# and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Google BigQuery, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

We encourage you to download Google BigQuery Connector for C# and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Google BigQuery Connector for C# Documentation

More integrations

Other connectors for C#

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google Ads

Google Calendar

Google Drive

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Starburst

Stripe

Trino

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Other application integration scenarios for Google BigQuery

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Common Searches: