atdatabases icon indicating copy to clipboard operation
atdatabases copied to clipboard

BigQuery and TypeScript

Open duncanbeevers opened this issue 1 year ago • 1 comments

A -typed ecosystem for BigQuery

In order to get the same kind of type-safety for BigQuery as is offered for Postgres by pg-typed, and in the same vein as this request to create sqlite-typed, I'd like to see this project extend its support.

Steps to get a -typed ecosystem for BigQuery

  • create bigquery-schema-cli to generate TypeScript types from BigQuery schemas
    • get table names and column schemas for a dataset using the Google BigQuery getTables() and getMetadata() methods.
    • generate TypeScript interfaces for tables and for the overall dataset
  • create bigquery-typed to expose the -typed interface over BigQuery tables
  • (optional) create bigquery-bulk to expose BigQuery's batch loading methods

duncanbeevers avatar Aug 22 '24 18:08 duncanbeevers

I've written utilities for gathering the BigQuery dataset schemas, and for generating TypeScript interfaces from those schemas here, which could serve as a starting point for bigquery-schema-cli.

duncanbeevers avatar Aug 22 '24 18:08 duncanbeevers