All Connectors
BigQuery Connector
BigQuery Connector
BigQuery Connector
Connect to a BigQuery database and expose it to Hasura v3 Project
About
Version
Released
September 20, 2024
Last Updated
October 10, 2024
GitHub Repo

BigQuery Connector

Docs ndc-hub License Status

With this connector, Hasura allows you to instantly create a real-time GraphQL API on top of your data models in BigQuery. This connector supports BigQuery's functionalities listed in the table below, allowing for efficient and scalable data operations. Additionally, users benefit from all the powerful features of Hasura’s Data Delivery Network (DDN) platform, including query pushdown capabilities that delegate query operations to the database, thereby enhancing query optimization and performance.

This connector is built using the Rust Data Connector SDK and implements the Data Connector Spec.

Features

Below, you'll find a matrix of all supported features for the BigQuery connector:

FeatureSupportedNotes
Native Queries + Logical Models
Native Mutations
Simple Object Query
Filter / Search
Simple Aggregation
Sort
Paginate
Table Relationships
Views
Remote Relationships
Stored Procedures
Custom Fields
Mutations
Distinct
Enums
Naming Conventions
Default Values
User-defined Functions

Prerequisites

  1. Create a Hasura Cloud account
  2. Please ensure you have the DDN CLI and Docker installed
  3. Create a supergraph
  4. Create a subgraph

The steps below explain how to initialize and configure a connector on your local machine (typically for development purposes).You can learn how to deploy a connector to Hasura DDN — after it's been configured — here.

Using the BigQuery connector

With the context set for an existing subgraph, initialize the connector by choosing hasura/bigquery. When the wizard runs, you'll also be prompted to enter the following env vars necessary for your connector to function:

Environment Variables

NameDescriptionRequiredDefault
HASURA_BIGQUERY_SERVICE_KEYThe service key of the BigQuery projectYesN/A
HASURA_BIGQUERY_PROJECT_IDThe project ID of the BigQuery databse projectYesN/A
HASURA_BIGQUERY_DATASET_IDThe dataset ID of the BigQuery databse projectYesN/A

After the CLI initializes the connector, you'll need to:

Documentation

View the full documentation for the ndc-bigquery connector here.

Contributing

We're happy to receive any contributions from the community. Please refer to our development guide.

License

The Hasura BigQuery connector is available under the Apache License 2.0.

2024 Edition

The GraphQL Handbook

A GraphQL Handbook for developers and architects to help plan your GraphQL adoption journey.
The GraphQL Handbook

Ship a rock-solid API on your data – in minutes!