Overview

Google BigQuery plugin for Corsair

Use Google BigQuery through Corsair: one client, typed API calls, local DB sync.

What you get:

• 62 typed API operations
• 5 synced entities (datasets, jobs, models, routines, tables) for fast .search() / .list()

Setup

1. Install

   npm

   npm install corsair @corsair-dev/googlebigquery
   
2. Add the plugin

   corsair.ts

   import Database from 'better-sqlite3';
   import { createCorsair } from 'corsair';
   import { googlebigquery } from '@corsair-dev/googlebigquery';
   
   export const corsair = createCorsair({
   	plugins: [
   		googlebigquery(),
   	],
   	database: new Database('corsair.db'),
   	kek: process.env.CORSAIR_KEK!,
   	hub: {
   		projectApiKey: process.env.CORSAIR_DEV_API_KEY!,
   		signingSecret: process.env.CORSAIR_DEV_SIGNING_SECRET!,
   	},
   });
   

   Multi-tenancy is the default — scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

3. Choose authentication

   OAuth 2.0 (Recommended)

   Open hub.corsair.dev, navigate to your project, and enter the client ID and client secret from your Google BigQuery OAuth app.

   googlebigquery()
   

   More: OAuth 2.0

4. Connect a tenant

   Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

   const { connectUrl } = await corsair.manage.connect.createLink({
   	plugin: 'googlebigquery',
   	tenantId: 'acme',
   });
   // redirect the user's browser to connectUrl
   

Example API calls

analyticsHub.listDataexchangesListings

const tenant = corsair.withTenant('acme');
await tenant.googlebigquery.api.analyticsHub.listDataexchangesListings({});

analyticsHub.createDataExchange

const tenant = corsair.withTenant('acme');
await tenant.googlebigquery.api.analyticsHub.createDataExchange({});

See the full list on the API page.

Query synced data

Synced entities support tenant.googlebigquery.db.<entity>.search() and .list(): datasets, jobs, models, routines, tables.

See Database for filters and operators.

What’s next

API reference

Every googlebigquery.api.* operation with input and output types.

Database

Synced entities, search filters, and operators.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.