Skip to main content
Version: v2.x

BigQuery: Tables Basics


Adding tables allows you to define the GraphQL types of your schema including their corresponding fields.

Creating tables

Let's say we want to create two simple tables for articles and author schema:

authors (
`id` INT64,
`name` STRING

articles (
`id` INT64,
`title` STRING,
`body` STRING,
`author_id` INT64,
`is_published` BOOL,
`published_on` DATETIME,
`rating` INT64

Open the Hasura Console and head to the Data tab and click on the button on the left side bar to open up an interface to create tables.

For example, here is the schema for the articles table in this interface:

Schema for an article table

Tracking tables

Tables can be present in the underlying BigQuery database without being exposed over the GraphQL API. In order to expose a table over the GraphQL API, it needs to be tracked.

When a table is created via the Hasura Console, it gets tracked by default.

You can track any existing tables in your database from the Data -> Schema page:

Track table

Generated GraphQL schema types

As soon as a table is created and tracked, the corresponding GraphQL schema types and query/mutation fields will be automatically generated.

The following object type is generated for the articles table we just created and tracked:

# Object type
type Articles {
id: Int
title: String
body: String
author_id: Int
is_published: Boolean
published_on: Datetime
rating: Int

Let's analyze the above type:

  • Articles is the name of the type
  • id, title, body, and so on are fields of the Articles type
  • Int and String, Boolean and Datetime are types that fields can have

The following query/mutation fields are generated for the articles table we just created and tracked:

# Query field: fetch data from the table: "bigquery.articles"
distinct_on: [bigquery_articles_select_column!]
limit: Int
offset: Int
order_by: [bigquery_articles_order_by!]
where: bigquery_articles_bool_exp
): [bigquery_articles!]!

# Query field: fetch aggregated fields from the table: "bigquery.articles"
distinct_on: [bigquery_articles_select_column!]
limit: Int
offset: Int
order_by: [bigquery_articles_order_by!]
where: bigquery_articles_bool_exp
): bigquery_articles_aggregate!

These auto-generated fields will allow you to query data in the table.

See the query API reference for the full specifications.

GraphQL types documentation

Hasura automatically picks up any comments that might have been added to your tables and columns and adds them as GraphQL descriptions of the auto-generated types and fields.

Try out basic GraphQL requests

At this point, you should be able to try out basic GraphQL queries/mutations on the newly created tables from the API tab in the Console. (You may want to add some sample data into the tables first)

  • Query all rows in the articles table:

    Query Variables
    Request Headers
    Documentation Explorer
    No Schema Available