BigQuery support
Squids can store their data to BigQuery datasets using the @subsquid/bigquery-store
package. Define and use the Database
object as follows:
import {
Column,
Table,
Types,
Database
} from '@subsquid/bigquery-store'
import {BigQuery} from '@google-cloud/bigquery'
const db = new Database({
bq: new BigQuery(),
dataset: 'subsquid-datasets.test_dataset',
tables: {
TransfersTable: new Table(
'transfers',
{
from: Column(Types.String()),
to: Column(Types.String()),
value: Column(Types.BigNumeric(38))
}
)
}
})
processor.run(db, async ctx => {
// ...
let from: string = ...
let to: string = ...
let value: bigint | number = ...
ctx.store.TransfersTable.insert({from, to, value})
})
Here,
bq
is aBigQuery
instance. When created without arguments like this it'll look at theGOOGLE_APPLICATION_CREDENTIALS
environment variable for a path to a JSON with authentication details.dataset
is the path to the target dataset.
The dataset must be created prior to running the processor.
tables
lists the tables that will be created and populated within the dataset. For every field of thetables
object an eponymous field of thectx.store
object will be created; callinginsert()
orinsertMany()
on such a field will result in data being queued for writing to the corresponding dataset table. The actual writing will be done at the end of the batch in a single transaction, ensuring dataset integrity.
Tables are made out of statically typed columns. Available types are listed on the reference page.
Deploying to SQD Cloud
We discourage uploading any sensitive data with squid code when deploying to SQD Cloud. To pass your credentials JSON to your squid, create a Cloud secret variable populated with its contents:
sqd secrets set GAC_JSON_FILE < creds.json
Then in src/main.ts
write the contents to a file:
import fs from 'fs'
fs.writeFileSync('creds.json', process.env.GAC_JSON_FILE || '')
Set the GOOGLE_APPLICATION_CREDENTIALS
variable and request the secret in the deployment manifest:
deploy:
processor:
env:
GAC_JSON_FILE: ${{ secrets.GAC_JSON_FILE }}
GOOGLE_APPLICATION_CREDENTIALS: creds.json
Examples
An end-to-end example geared towards local runs can be found in this repo. Look at this branch for an example of a squid made for deployment to SQD Cloud.