Skip to content

fix(api): add useJsonNativeFormat to MySQL and Postgres ClickPipe settings - #1491

Open
sdairs wants to merge 1 commit into
claude/drift-1482-cli-postgres-private-endpointfrom
claude/drift-clickpipes-json-native-api
Open

sdairs wants to merge 1 commit into
claude/drift-1482-cli-postgres-private-endpointfrom
claude/drift-clickpipes-json-native-api

Conversation

@sdairs

@sdairs sdairs commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Refs #1490. API PR for drift that appeared after #1482 was filed, stacked on #1489. CLI exposure follows in #1492.

  • Refreshes clickhouse_cloud_openapi.json. The only spec change is the new useJsonNativeFormat property on ClickPipeMySQLPipeSettings and ClickPipePostgresPipeSettings.
  • use_json_native_format: Option<bool> on those two request types and their *Response types.
  • Analyzer: optionality exemption ("ClickPipePostgresPipeSettings", "useJsonNativeFormat"). That schema has no required[], so the description fallback marks the field required. But it is create-only and must be enabled per organization, so a required bool would send false from every caller, as with iamRoleExternalId (AWS backup bucket create cannot succeed in orgs without the external-ID feature (iamRoleExternalId required by the library, rejected by the server) #1245). Not yet confirmed against the live API. The MySQL schema has a required[] without it, so it needs no entry.
  • Breaking for struct-literal callers (use_json_native_format: None); see CHANGELOG.md.
  • Tests: model tests check that the field is omitted when unset, uses its wire name, and is read in responses. Live ClickPipes test literals are updated.
  • CLI: compile-only, sends None, so its requests are unchanged.

spec_coverage_test passes, and the live drift dry-run reports 0 actionable findings at the top of the stack.

🤖 Generated with Claude Code


Note

Low Risk
Adds optional API model fields and spec sync; CLI behavior unchanged (None). Postgres optionality exemption is noted as not yet live-verified.

Overview
Adds useJsonNativeFormat to the synced OpenAPI spec and Rust models for MySQL and Postgres ClickPipe create settings (ClickPipeMySQLPipeSettings, ClickPipePostgresPipeSettings, plus their *Response types). Callers may set use_json_native_format: Some(true) to land JSON source columns in native ClickHouse JSON (25.3+) instead of String; None omits the field. The field is create-only and org feature-gated.

Breaking: struct-literal builders must add use_json_native_format: None. The openapi analyzer adds an optionality exemption for Postgres so the field is not treated as required (avoiding implicit false for orgs without the feature). clickhousectl wires None only—no CLI flag yet. Tests cover omit/set serialization and response parsing; live pipe tests updated.

Reviewed by Cursor Bugbot for commit 120f1a9. Bugbot is set up for automated code reviews on this repo. Configure here.

…tings

Refreshes the snapshot to the live spec, which adds optional
`useJsonNativeFormat` to `ClickPipeMySQLPipeSettings` and
`ClickPipePostgresPipeSettings`. The field is create-only and
organization-gated, so it is `Option<bool>` on all four types, with an
optionality exemption on the Postgres request type, whose schema has no
`required[]`. The CLI passes `None`, so its requests are unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sdairs
sdairs requested a review from iskakaushik as a code owner November 17, 2026 17:43
@sdairs
sdairs added this pull request to stack #1483 November 17, 2026 17:43

This branch has not been deployed

No deployments
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