Skip to content

feat(cli): expose SQL schema without sample row output - #128

Draft
rtiman-spotify wants to merge 4 commits into
spotify:mainfrom
rtiman-spotify:cli-sql-schema
Draft

rtiman-spotify wants to merge 4 commits into
spotify:mainfrom
rtiman-spotify:cli-sql-schema

Conversation

@rtiman-spotify

Copy link
Copy Markdown

Summary

Adds data sql schema --name sqlJobs/... using the existing GetSampleRows endpoint. Outputs only known schema fields, column issues, table issues and pending/failed result metadata; never prints raw sample results, rows or unrelated job statistics.

Dependencies

Depends on #127 and transitively #122. The fork branch contains those exact commits; its main-targeted diff includes both prerequisites until they land. Kept draft; do not merge out of order.

Privacy and semantics

The backend endpoint may send rows over the wire: this is strict client-side projection, not a server no-row guarantee. Row data is not printed, logged, persisted or sent to telemetry/models. A pending/failed result is inspected successfully with schema:null and explicit state; HTTP/authentication/malformed-response errors exit nonzero. No new queries, polling or retries. Dry-run validates names without auth/HTTP/writes/telemetry.

Verification

Node 24, pnpm build and full pnpm qa passed. 31 focused MSW tests cover JSON/human sample-row non-disclosure, projection of unknown nested fields, result oneofs, malformed schema, pending/failure semantics, permissions/missing jobs and auth-free dry-run. Existing E2E regression runs in CI. No live API compatibility claim.

Checklist

  • Local build/typecheck/lint/unit tests passed
  • CLI documentation updated with wire-level limitation
  • Privacy and behavior tests added
  • TUI screenshots (not applicable)

Related: https://spotify.atlassian.net/browse/SLMD-1921.

rtiman-spotify and others added 4 commits October 19, 2026 15:30
Co-Authored-By: Xirp Agent (gpt-6.1-sol) <xirp-agent@users.noreply.ghe.spotify.net>
Co-Authored-By: Xirp Agent (gpt-6.1-sol) <xirp-agent@users.noreply.ghe.spotify.net>
Co-Authored-By: Xirp Agent (gpt-6.1-sol) <xirp-agent@users.noreply.ghe.spotify.net>
Co-Authored-By: Xirp Agent (gpt-6.1-sol) <xirp-agent@users.noreply.ghe.spotify.net>
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