refactor: rename AnalyticsFormat to API enum names (JSON_ARRAY, ARROW_STREAM)#328
Open
jamesbroadhead wants to merge 1 commit intostack/arrow-1-coverage-testsfrom
Open
refactor: rename AnalyticsFormat to API enum names (JSON_ARRAY, ARROW_STREAM)#328jamesbroadhead wants to merge 1 commit intostack/arrow-1-coverage-testsfrom
jamesbroadhead wants to merge 1 commit intostack/arrow-1-coverage-testsfrom
Conversation
Renames the client-side analytics format model from "JSON"/"ARROW" to
"JSON_ARRAY"/"ARROW_STREAM" to match the Statement Execution API enum
verbatim — no more local-name to API-name translation.
Pure mechanical rename. No behavior change. Internal type values only;
the lowercase user-facing values passed to useChartData ("json", "arrow",
"auto") are unchanged.
Carved out of #256 (#327 is layer 1, this is layer 2). The actual
inline-Arrow-IPC + warehouse-fallback fix sits on top of this in layer 3.
Note: this is a breaking change for any direct consumer of
useAnalyticsQuery passing explicit format: "JSON" or "ARROW" — they will
need to update to "JSON_ARRAY" / "ARROW_STREAM". Consumers using
useChartData (lowercase "json"/"arrow"/"auto") are unaffected.
Co-authored-by: Isaac
This was referenced Apr 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Pure mechanical rename of the client-side analytics format model:
"JSON"→"JSON_ARRAY""ARROW"→"ARROW_STREAM"These match the verbatim enum values in the Databricks Statement Execution API (
Format), so we no longer translate to/from local aliases.Stack
Based on #327. Review independently — no behavior change.
Breaking change note
Direct consumers of
useAnalyticsQuerypassing explicitformat: "JSON"orformat: "ARROW"will need to update to"JSON_ARRAY"/"ARROW_STREAM". Consumers ofuseChartData(which takes lowercase"json"/"arrow"/"auto") are unaffected.Test plan
AnalyticsFormatThis pull request was AI-assisted by Isaac.