Skip to content

Document query response shapes in README - #229

Open
stsingh wants to merge 4 commits into
mainfrom
sahej/readme-response-shapes
Open

stsingh wants to merge 4 commits into
mainfrom
sahej/readme-response-shapes

Conversation

@stsingh

@stsingh stsingh commented Nov 20, 2026

Copy link
Copy Markdown
Contributor

Why. The README shows how to call the query APIs but not what comes back.

Change. The README now documents:

  • Reading results: the OnlineQueryResult getters, a sample scalars table, the ServerError fields, and a note to check errors first, because a resolver failure can null a row.
  • Offline query result files: the Parquet column layout.

It also fixes three broken examples:

  • one requested full_name but read spending_mean_30d
  • one assigned getVarCharObj to a long
  • two read card_user.id without requesting it as an output

Verified. The sample table and error behavior come from 1.3.14 queries against a test environment, over both HTTP and gRPC.

🤖 Generated with Claude Code

stsingh and others added 4 commits November 20, 2026 22:57
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@stsingh
stsingh marked this pull request as ready for review November 20, 2026 23:11
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