C# Google BigQuery Connector In this article you will learn how to integrate Google BigQuery data to C# (live / bi-directional connection to Google BigQuery). Read / write Google BigQuery data inside your app without coding using easy to use high performance API Connector. Using Google BigQuery Connector you will be able to connect, read, and write data from within C#. Follow the steps below to see how we would accomplish that. Download  Help File  Buy  Driver mentioned in this article is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. ODBC PowerPack - System Requirements and Installation Getting Started - Using ODBC PowerPack ODBC API Driver Help File

See also Connect Google BigQuery in SSIS Connect Google BigQuery in SQL Server Connect Google BigQuery in Power BI Connect Google BigQuery in SSRS Connect Google BigQuery in Informatica Connect Google BigQuery in MS Access Connect Google BigQuery in MS Excel Connect Google BigQuery in SSAS Connect Google BigQuery in Python Connect Google BigQuery in JAVA Connect Google BigQuery in Tableau Connect Google BigQuery in SAP Crystal Reports Connect Google BigQuery in Azure Data Factory (ADF) Connect Google BigQuery in ODBC

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

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

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

3. Create a User Data Source (User DSN) based on ZappySys API Driver

   ZappySys API Driver

   
   You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.

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]

   Steps to get Google BigQuery Credentials
   This connection can be configured using two ways. Use Default App (Created by ZappySys) OR Use Custom App created by you.
   To use minimum settings you can start with ZappySys created App. Just change UseCustomApp=false on the properties grid so you dont need ClientID / Secret. When you click Generate Token you might see warning about App is not trusted (Simply Click Advanced Link to expand hidden section and then click Go to App link to Proceed).

   To register custom App, perform the following steps (Detailed steps found in the help link at the end)

   1. Go to Google API Console
   2. From the Project Dropdown (usually found at the top bar) click Select Project
   3. On Project Propup click CREATE PROJECT
   4. Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
   5. Click ENABLE APIS AND SERVICES
   6. Now we need to Enable two APIs one by one (BigQuery API and Cloud Resource Manager API).
   7. Search BigQuery API. Select and click ENABLE
   8. Search Cloud Resource Manager API. Select and click ENABLE
   9. Go to back to main screen of Google API Console

   10. Click OAuth consent screen Tab. Enter necessary details and Save.

       1. Choose Testing as Publishing status
       2. Set application User type to Internal, if possible
       3. If MAKE INTERNAL option is disabled, then add a user in Test users section, which you will use in authentication process when generating Access and Refresh tokens
   11. Click Credentials Tab
   12. Click CREATE CREDENTIALS (some where in topbar) and select OAuth Client ID option.
   13. When prompted Select Application Type as Desktop App and click Create to receive your ClientID and Secret. You can use this information now to configure Connection with UseCustomApp=true.

   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	Fill in the parameter...
   DatasetId	Fill in the parameter...
   Optional Parameters
   ClientId	Fill in the parameter...
   ClientSecret	Fill in the parameter...
   Scope	Fill in the parameter...
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...
   Job Location	Fill in the parameter...

   

    Service Account (Using Private Key File) [OAuth]

   Steps to get Google BigQuery Credentials
   Use these steps to authenticate as service account rather than Google / GSuite User. Learn more about service account here

   Basically to call Google API as Service account we need to perform following steps listed in 3 sections (Detailed steps found in the help link at the end)

   Create Project

   First thing is create a Project so we can call Google API. Skip this section if you already have Project (Go to next section)

   1. Go to Google API Console
   2. From the Project Dropdown (usually found at the top bar) click Select Project
   3. On Project Propup click CREATE PROJECT
   4. Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
   5. Click ENABLE APIS AND SERVICES
   6. Now we need to Enable two APIs one by one (BigQuery API and Cloud Resource Manager API).
   7. Search BigQuery API. Select and click ENABLE
   8. Search Cloud Resource Manager API. Select and click ENABLE

   Create Service Account

   Once Project is created and APIs are enabled we can now create a service account under that project. Service account has its ID which looks like some email ID (not to confuse with Google /Gmail email ID)

   1. Go to Create Service Account
   2. From the Project Dropdown (usually found at the top bar) click Select Project
   3. Enter Service account name and Service account description
   4. Click on Create. Now you should see an option to assign Service Account permissions (See Next Section).

   Give Permission to Service Account

   By default service account cant access BigQuery data or List BigQuery Projects so we need to give that permission using below steps.

   1. After you Create Service Account look for Permission drop down in the Wizard.
   2. Choose BigQuery -> BigQuery Admin role so we can read/write data. (NOTE: If you just need read only access then you can choose BigQuery Data Viewer)
   3. Now choose one more Project -> Viewer and add that role so we can query Project Ids.
   4. Click on Continue. Now you should see an option to Create Key (See Next Section).

   Create Key (P12)

   Once service account is created and Permission is assigned we need to create key file.

   1. In the Cloud Console, click the email address for the service account that you created.
   2. Click Keys.
   3. Click Add key, then click Create new key.
   4. Click Create and select P12 format. A P12 key file is downloaded to your computer. We will use this file in our API connection.
   5. Click Close.
   6. Now you may use downloaded *.p12 key file as secret file and Service Account Email as Client ID (e.g. some_name@some_name.iam.gserviceaccount.com).

   Manage Permissions / Give Access to Other Projects

   We saw how to add permissions for Service Account during Account Creation Wizard but if you ever wish to edit after its created or you wish to give permission for other projects then perform forllowing steps.

   1. From the top Select Project for which you like to edit Permission.
   2. Go to IAM Menu option (here)
      Link to IAM: https://console.cloud.google.com/iam-admin/iam
   3. Goto Permissions tab. Over there you will find ADD button.
   4. Enter Service account email for which you like to grant permission. Select role you wish to assign.

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

   GoogleBigQueryDSN

   Google BigQuery

   Service Account (Using Private Key File) [OAuth]

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

   Required Parameters
   Service Account Email	Fill in the parameter...
   Service Account Private Key Path (i.e. *.p12)	Fill in the parameter...
   ProjectId	Fill in the parameter...
   DatasetId	Fill in the parameter...
   Optional Parameters
   Scope	Fill in the parameter...
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...
   Job Location	Fill in the parameter...

   

6. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
   

7. Click OK to finish creating the data source.

Read data in C# from the 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);
                   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();
           }
       }
   }
   

4. 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 . 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://services.odata.org/V3/Northwind/Northwind.svc;Provider=OData;AuthName=Http;";
   
   using (var conn = new OdbcConnection(connectionString))
   {
       // ...
   }
   

   How to Overcome the Long Connection String Issue

   This issue is typically caused when the connection string includes a long RefreshToken attribute (i.e. RefreshToken=xxxxxxxxxxxx...xxx, especially if it's more than 1,000 characters).

   A good solution is to supply the RefreshToken by a file. Simply copy and paste the RefreshToken into a text file and save it, and then pass that file path in the connection string instead of directly supplying the RefreshToken.

   Here is an example of a connection string that can cause the issue:

   
   var connectionString = "Driver={ZappySys API Driver};RefreshToken=xxxxxxxxxxxx...xxxxxxx;ServiceUrl=...;";
   
   using (var conn = new OdbcConnection(connectionString))
   {
       // ...
   }
   

   Here is an example of a connection string that has resolved the issue by moving the RefreshToken attribute to the file c:\my_refresh_token.txt:

   
   var connectionString = "Driver={ZappySys API Driver};RefreshTokenFile=c:\my_refresh_token.txt;ServiceUrl=...;";
   
   using (connectionString)
   {
       // ...
   }
   

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
   

2. Enter the desired Procedure name and click on OK:
   

3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
   Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
   

   CREATE PROCEDURE [usp_get_orders]
       @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
    AS
       SELECT * FROM Orders where OrderDate >= '<@fromdate>';
   

   
   

4. That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
   

   Exec usp_get_orders '1996-01-01';

   
   

5. Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
   As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
   

   SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

   
   

6. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
   

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
   

2. Enter the desired Table name and click on OK:
   

3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
   Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
   

   SELECT
     "ShipCountry",
     "OrderID",
     "CustomerID",
     "EmployeeID",
     "OrderDate",
     "RequiredDate",
     "ShippedDate",
     "ShipVia",
     "Freight",
     "ShipName",
     "ShipAddress",
     "ShipCity",
     "ShipRegion",
     "ShipPostalCode"
   FROM "Orders"
   Where "ShipCountry"='USA'

   
   

5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
   

   SELECT * FROM "vt__usa_orders_only"

   
   

6. Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
   As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
   

   SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

   
   

7. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
   

Conclusion

Download Google BigQuery Connector for C# Documentation 

Actions supported by Google BigQuery Connector

Other App 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 (ADF)

ODBC

Other Connectors for C#

Zendesk

Azure DevOps

ManagedEngine ServiceDesk Plus (Zoho)

Zoho CRM

Hubspot

Google Sheets

Stripe

YouTube

Google BigQuery

OneDrive

OData

Amazon Ads

Mailchimp

Jira

Outlook Mail (Office 365)

Zoom

Cosmos DB

Shopify

Nativo

Google Drive

SharePoint Online

Amazon MWS

ServiceNow

ElasticSearch

Google Calendar

DropBox

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

Download Google BigQuery Connector for C# Documentation 

Common Searches: