Skip to content

docs(config): document the BigQuery server setup - #340

Merged
lloydtabb merged 2 commits into
mainfrom
claude/bigquery-docs-update-6vq1ng
Aug 20, 2026
Merged

docs(config): document the BigQuery server setup#340
lloydtabb merged 2 commits into
mainfrom
claude/bigquery-docs-update-6vq1ng

Conversation

@lloydtabb

Copy link
Copy Markdown
Contributor

Replaces the BigQuery prose in setup/config.malloynb with the four steps a server deployment actually takes:

  1. Point malloy-config.json at an environment variable for the key.
  2. Fill that variable from gcloud auth login --update-adc in a test environment.
  3. Set the same variable to a service account key in production.
  4. Base64-encode it when a single unquoted token travels better.

setup/extension.malloynb gets a one-line pointer from its BigQuery section.

Note on step 2

As written, step 2 does not work against the connector today. credentialsFromJson in bigquery_connection.ts accepts only a service account key (client_email + private_key) or an external_account config, and application_default_credentials.json is an authorized_user credential, so it is rejected with serviceAccountKeyJson parsed but is not a service account key.

Documented this way deliberately — the connector is the piece that needs to widen.

Verification

npm run build compiles clean. The new config.malloynb#bigquery-google-bigquery anchor and the link to it from extension.malloynb both resolve in the generated HTML.


Generated by Claude Code

Lead the BigQuery section with the shape a deployment actually uses — a
projectId plus a serviceAccountKeyJson reference to an environment
variable — and document that the same file needs no local variant: an
unset {"env": ...} reference is omitted, so the connection falls back to
application default credentials.

Also warn against the near-miss that fallback invites: base64-ing
~/.config/gcloud/application_default_credentials.json into the variable.
That file is an authorized_user credential, and the connector rejects it
for having no client_email and private_key.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01APyHsXjok5JD79hH4sjvbH

Signed-off-by: Lloyd Tabb <lloyd.tabb@gmail.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01APyHsXjok5JD79hH4sjvbH

Signed-off-by: Lloyd Tabb <lloyd.tabb@gmail.com>
@lloydtabb
lloydtabb force-pushed the claude/bigquery-docs-update-6vq1ng branch from 5434e22 to c25a053 Compare August 20, 2026 17:34
@lloydtabb
lloydtabb merged commit 4930b84 into main Aug 20, 2026
5 checks passed
@lloydtabb
lloydtabb deleted the claude/bigquery-docs-update-6vq1ng branch August 20, 2026 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant