Getting Started with the CData Connect AI Python SDK for BigQuery

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Install the CData Connect AI Python SDK to read and write live BigQuery data with standard DB-API 2.0 Python code.

The CData Connect AI Python SDK (cdata-connect-ai) is a DB-API 2.0 (PEP 249) compliant client that lets you fetch and act on live BigQuery data with standard Python database code. Because Connect AI provides the connectivity: you install one package, authenticate with a Personal Access Token, and query BigQuery (and every other source connected in Connect AI) using the same familiar connect() / cursor() / fetchall() pattern you already know from libraries like sqlite3 and psycopg2.

This guide walks through connecting BigQuery in Connect AI, generating a Personal Access Token, installing the SDK, and reading (and, where supported, writing) live BigQuery data.

Prerequisites

  • An account in CData Connect AI
  • Python 3.8 or higher
  • An active BigQuery account with valid credentials

About BigQuery Data Integration

CData simplifies access and integration of live Google BigQuery data. Our customers leverage CData connectivity to:

  • Simplify access to BigQuery with broad out-of-the-box support for authentication schemes, including OAuth, OAuth JWT, and GCP Instance.
  • Enhance data workflows with Bi-directional data access between BigQuery and other applications.
  • Perform key BigQuery actions like starting, retrieving, and canceling jobs; deleting tables; or insert job loads through SQL stored procedures.

Most CData customers are using Google BigQuery as their data warehouse and so use CData solutions to migrate business data from separate sources into BigQuery for comprehensive analytics. Other customers use our connectivity to analyze and report on their Google BigQuery data, with many customers using both solutions.

For more details on how CData enhances your Google BigQuery experience, check out our blog post: https://www.cdata.com/blog/what-is-bigquery


Getting Started


Connect to BigQuery in Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. Adding a Connection
  3. Select "BigQuery" from the Add Connection panel
  4. Selecting a data source
  5. BigQuery uses OAuth to authenticate. Click "Sign in" to authenticate with BigQuery. Authenticating with OAuth (Salesforce is shown).
  6. Navigate to the Permissions tab and update the user-based permissions. Updating permissions

Generate a Personal Access Token (PAT)

The Python SDK authenticates to Connect AI with your account email and a Personal Access Token (PAT). It is best practice to create a separate PAT for each application to maintain granularity of access.

  1. Click the Gear icon () at the top right of the Connect AI app to open the Settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. Creating a new PAT
  4. The PAT is only visible at creation, so copy it and store it securely.

Install the SDK

Install the SDK from PyPI with pip:

pip install cdata-connect-ai

Connect and Run Your First Query

Connect with your account email and PAT, then query sys_tables to discover every table available across your connected sources. Identifiers in Connect AI are three-part: <Connection>.<Schema>.<Table>, where the connection name defaults to the source name (for example, GoogleBigQuery1).

import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)
cur = conn.cursor()

# Discover what's available across your connected sources
cur.execute("SELECT CatalogName, SchemaName, TableName FROM sys_tables LIMIT 25")

for row in cur.fetchall():
    print(row)

Pick any table from the results and query it directly:

cur.execute(
    "SELECT OrderName, Freight "
    "FROM [GoogleBigQuery1].[GoogleBigQuery].[Orders] "
    "LIMIT 10"
)

for row in cur.fetchall():
    print(row)

Write Back to BigQuery

When the data source and your connection permissions allow it, the same cursor runs INSERT, UPDATE, and DELETE statements. Bind values with pyformat (%(name)s) parameters, exactly as you would for a filtered read, and check cursor.rowcount for the number of affected rows.

# Insert a new record
cur.execute(
    "INSERT INTO [GoogleBigQuery1].[GoogleBigQuery].[Orders] (OrderName) "
    "VALUES (%(newvalue)s)",
    {"newvalue": "Example value"},
)
print(f"Rows inserted: {cur.rowcount}")

# Update existing records
cur.execute(
    "UPDATE [GoogleBigQuery1].[GoogleBigQuery].[Orders] "
    "SET Freight = %(newvalue)s "
    "WHERE ShipCity = 'New York'",
    {"newvalue": "Updated value"},
)
print(f"Rows updated: {cur.rowcount}")

conn.close()

Note: Even for writable sources, a read-only PAT or connection permission will reject write operations. The same parameterized pattern also covers DELETE statements and stored procedures through cursor.callproc().

That is the entire workflow: one package, a PAT, and standard DB-API calls. Because the SDK returns a normal DB-API connection, it drops straight into the rest of the Python data ecosystem. From here you can load BigQuery data into pandas, build ETL pipelines with petl, or power a Dash web app, all using this same connection.

More Information and Free Trial

Now you can query live BigQuery data from Python through the CData Connect AI Python SDK. For more information on connecting to BigQuery (and hundreds of other data sources), visit the Connect AI page. Sign up for a free trial and start working with live BigQuery data in Python.

Ready to get started?

Learn more about CData Connect AI or sign up for free trial access:

Free Trial