https://github.com/aiji42/cfw-bq

This is a BigQuery client library for Cloudflare Workers. It allows you to query BigQuery from within a Cloudflare Worker.
https://github.com/aiji42/cfw-bq

Last synced: 24 days ago
JSON representation

This is a BigQuery client library for Cloudflare Workers. It allows you to query BigQuery from within a Cloudflare Worker.

• Host: GitHub
• URL: https://github.com/aiji42/cfw-bq
• Owner: aiji42
• License: mit
• Created: 2024-02-15T02:55:10.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-04-26T06:25:15.000Z (8 months ago)
• Last Synced: 2024-10-16T01:23:29.739Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 83 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# BigQuery Client for Cloudflare Workers

This is a BigQuery client library for Cloudflare Workers. It allows you to query BigQuery from within a Cloudflare Worker.

## Installation

```sh

npm install cfw-bq

```

## Configuration

You need to provide the service account credentials as a secret in Cloudflare Workers.

```json

{

  "type": "service_account",

  "project_id": "your-project",

  "private_key_id": "your-private-key-id",

  "private_key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n",

  "client_email": "your-service-account-email",

  "client_id": "your-client-id",

  "auth_uri": "https://accounts.google.com/o/oauth2/auth",

  "token_uri": "https://oauth2.googleapis.com/token"

}

```

Set the secret in Cloudflare Workers:

```sh

wrangler secret put MY_CREDENTIALS

```

The secret name `MY_CREDENTIALS` is just an example. You can use any name you like.

## Usage

```ts

import { BigQuery } from 'cfw-bq';

export interface Env {

  MY_CREDENTIALS: string;

}

const project = '{your-project-id}';

export default {

  async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise {

    const bq = new BigQuery(JSON.parse(env.MY_CREDENTIALS), project);

    const query = 'SELECT * FROM `your-project.your-dataset.your-table` LIMIT 10';

    const result = await bq.query(query);

    return Response.json(result);

  }

};

```

### for TypeScript

You can specify the schema of the result by providing a generic type argument to the `query` method.

```ts

interface Row {

  id: number;

  name: string;

}

const result = await bq.query(query);

// result is of type Row[]

```

## License

MIT (see: [LICENSE](LICENSE))