Skip to content
/ bqjson Public

bqjson - Serialize/Deserialzie BigQuery TableResults to/from JSON

License

Notifications You must be signed in to change notification settings

shnewto/bqjson

Repository files navigation

GitHub Actions build Maven Central

bqjson

Serialize/Deserialize BigQuery TableResults (and TableResult adjacent types) to/from JSON.

Example

package com.github.shnewto.bqjson.SerDe;
/* ... */

class MyBigQueryService {
    void myBigQueryWork() {
        /* Get a table result from BigQuery */
        TableResult originalTableResult = bigQuery
                .create(JobInfo.newBuilder(queryConfig)
                .setJobId(jobId).build())
                .waitFor()
                .getQueryResults();
        
        /* Serialize TableResult to JSON */
        String jsonString = SerDe.toJson(originalTableResult);
        /* Deserialize the JSON back into a TableResult */
        TableResult reconstitutedTableResult = SerDe.fromJson(jsonString, TableResult.class);
        
        /* ... */
    }
}

Why?

This package came about because I wanted to write tests for parts of applications that use BQ TableResults, but didn't want to have to actually interact with BQ to run them. I'd hoped that writing TableResults to JSON files (that I could read in and use on the next test runs) would be trivial. When it wasn't, I wrote this helper library so it could be.

Notes

Please raise issues or make PRs if you have a question or spot a bug ❤️❤️