BQSQL

BigQuery Nodejs helper functions

Installation

Bqsql requires Node.js v16+ to run.

install using npm

npm install bqsql

Usage

import the package

const { initBQ } = require('bqsql');

initialize the client

const bq =  initBQ('<GOOGLE-PROJECT-ID>', credentials);

The client takes the following arguments

|Parameter |example |description | |----------------|-------------------------------|-----------------------------| |GOOGLE PROJECT ID|'google-project-id' |This is the project id found in the google cloud console | |credentials|{client_email: 'email', private_key: 'privKey'} |This is an object with the following properties: client_email and private_key |

The client has the following methods

bq.upsertBQ('<BIG QUERY DATASET ID>', '<BIG QUERY TABLE ID>', dataObject, searchObject)

bq.updateBQ('<BIG QUERY DATASET ID>', '<BIG QUERY TABLE ID>', dataObject, searchObject)

bq.insertIntoBQ('<BIG QUERY DATASET ID>', '<BIG QUERY TABLE ID>', dataObject)

bq.selectFromBQ('<BIG QUERY DATASET ID>', '<BIG QUERY TABLE ID>', searchObject)

|Parameter |example |description | |----------------|-------------------------------|-----------------------------| |BIG QUERY DATASET ID|'companydataset' |This is the dataset id found in the google cloud console | |BIG QUERY TABLE ID|'tableid' |This is the table id found in the gcp bigquery page| |dataObject|'{ datefield: new Date(), stringField: 'somestring'}' | This is the data object we want to create or update| |searchObject|'{ id: '123' }' | This object is used at the WHERE clause to select or update specific rows|