BigQuery Connector
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:
| Feature | Supported | Notes |
|---|---|---|
| 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
- Create a Hasura Cloud account
- Please ensure you have the DDN CLI and Docker installed
- Create a supergraph
- 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
| Name | Description | Required | Default |
|---|---|---|---|
| HASURA_BIGQUERY_SERVICE_KEY | The service key of the BigQuery project | Yes | N/A |
| HASURA_BIGQUERY_PROJECT_ID | The project ID of the BigQuery databse project | Yes | N/A |
| HASURA_BIGQUERY_DATASET_ID | The dataset ID of the BigQuery databse project | Yes | N/A |
After the CLI initializes the connector, you'll need to:
- Introspect the source.
- Add your models, commands, and relationships.
- Create a new build.
- Test it by running your project along with the connector.
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.
