Named tuples pretty format by Sasao4o · Pull Request #91779 · ClickHouse/ClickHouse

Sasao4o · 2025-12-09T10:18:16Z

Example:

-- Query
SELECT
    i.InstanceType,
    i.VCpuInfo.1 AS cpu,
    i.InstanceStorageInfo
FROM
(
    SELECT arrayJoin(InstanceTypes) AS i
    FROM instances
)
WHERE i.InstanceStorageSupported
ORDER BY cpu DESC
LIMIT 10


-- Output
┌─i.InstanceType─┬─cpu─┬─i.InstanceStorageInfo───────────────────┐
│ test.large     │  64 │ {                                      ↴│
│                │     │↳  "Disks": [                           ↴│
│                │     │↳   {                                   ↴│
│                │     │↳    "Count": 2,                        ↴│
│                │     │↳    "SizeGB": 1900,                    ↴│
│                │     │↳    "Type": "ssd"                      ↴│
│                │     │↳   }                                   ↴│
│                │     │↳  ],                                   ↴│
│                │     │↳  "EbsOptimizedSupport": "required",   ↴│
│                │     │↳  "EncryptionSupport": "required",     ↴│
│                │     │↳  "TotalSizeGB": 3800                  ↴│
│                │     │↳ }                                      │
│ test.xlarge    │  32 │ {                                      ↴│
│                │     │↳  "Disks": [                           ↴│
│                │     │↳   {                                   ↴│
│                │     │↳    "Count": 4,                        ↴│
│                │     │↳    "SizeGB": 2000,                    ↴│
│                │     │↳    "Type": "ssd"                      ↴│
│                │     │↳   }                                   ↴│
│                │     │↳  ],                                   ↴│
│                │     │↳  "EbsOptimizedSupport": "unsupported",↴│
│                │     │↳  "EncryptionSupport": "unsupported",  ↴│
│                │     │↳  "TotalSizeGB": 8000                  ↴│
│                │     │↳ }                                      │
└────────────────┴─────┴─────────────────────────────────────────┘

Changelog category (leave one):

Improvement

Changelog entry (a user-readable short description of the changes that goes into CHANGELOG.md):

In Pretty format, named tuples are now displayed as Pretty JSON. This closes #65022

CLAassistant · 2025-12-09T10:18:23Z

All committers have signed the CLA.

clickhouse-gh · 2025-12-09T15:47:56Z

Workflow [PR], commit [abbb03d]

Summary: ❌

job_name	test_name	status	info
AST fuzzer (amd_tsan)		failure
	Logical error: Unknown numeric column x of type: A	FAIL	cidb
BuzzHouse (amd_debug)		failure
	Logical error: 'Inconsistent AST formatting in Function_minus: the query:	FAIL	cidb
BuzzHouse (arm_asan)		failure
	Logical error: Invalid number of columns in chunk pushed to OutputPort. Expected A, found B	FAIL	cidb, issue
BuzzHouse (amd_ubsan)		failure
	Logical error: Distributed task iterator is not initialized	FAIL	cidb, issue
Performance Comparison (amd_release, master_head, 1/6)		failure
	Select historical data	failure
Performance Comparison (amd_release, master_head, 3/6)		failure
	Select historical data	failure
Performance Comparison (amd_release, master_head, 5/6)		failure
	Select historical data	failure
Performance Comparison (amd_release, master_head, 6/6)		failure
	Select historical data	failure

Sasao4o · 2025-12-09T19:01:26Z

Test failures are expected since the display of named tuples has changed. Should we update the tests to match the new output, or what do you think? @nihalzp

Copilot

Pull request overview

This PR adds support for formatting named tuples as pretty-printed JSON in ClickHouse's Pretty format output. When a named tuple is displayed in Pretty format, it now appears as indented JSON instead of the traditional tuple representation with parentheses, making nested structures more readable.

Key Changes:

Named tuples in Pretty format are now rendered as formatted JSON objects
Added is_pretty_format flag to FormatSettings to control this behavior
Modified the SerializationTuple class to use JSON serialization when Pretty format is detected

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tests/queries/0_stateless/03727_named_tuples_pretty_format.sql	Test case with nested named tuples and various data types
tests/queries/0_stateless/03727_named_tuples_pretty_format.reference	Expected output showing the pretty-printed JSON format
src/Processors/Formats/Impl/PrettyBlockOutputFormat.h	Changed format_settings from const to non-const to allow modification
src/Processors/Formats/Impl/PrettyBlockOutputFormat.cpp	Initialize format settings to enable pretty printing for JSON
src/Formats/FormatSettings.h	Added is_pretty_format boolean flag
src/DataTypes/Serializations/SerializationTuple.cpp	Modified serializeText to use JSON serialization for named tuples in Pretty format

Copilot · 2025-12-12T11:10:13Z

src/DataTypes/Serializations/SerializationTuple.cpp


 void SerializationTuple::serializeTextJSONPretty(const IColumn & column, size_t row_num, WriteBuffer & ostr, const FormatSettings & settings, size_t indent) const
 {
+


Remove unnecessary blank line that adds no value to code readability.

Suggested change

Copilot · 2025-12-12T11:10:14Z

src/DataTypes/Serializations/SerializationTuple.cpp

    if (settings.json.write_named_tuples_as_objects
        && has_explicit_names)
    {
+


Remove trailing whitespace that serves no purpose.

Suggested change

pamarcos · 2025-12-12T11:20:59Z

Test failures are expected since the display of named tuples has changed. Should we update the tests to match the new output, or what do you think? @nihalzp

In these cases, I think it's safer to add a new setting to use a new option in Format Settings to be able to choose to fallback to previous behavior. We set the new behavior by default, but allow these old tests (or people relying on previous behavior) to use the current output. Please choose a descriptive name for the format option and document it accordingly.

Also pay attention to the Style check job that failed.

src/DataTypes/Serializations/SerializationTuple.cpp

src/Formats/FormatSettings.h

src/Processors/Formats/Impl/PrettyBlockOutputFormat.cpp

…ty-format

Sasao4o · 2025-12-14T08:23:48Z

There is a case where the test failed because of a difference in width (may be this width is terminal or environment dependent). Do you think I should add an option like max_padding_width? @pamarcos

pamarcos · 2025-12-15T16:56:24Z

There is a case where the test failed because of a difference in width (may be this width is terminal or environment dependent). Do you think I should add an option like max_padding_width? @pamarcos

I think it was due to how the rows were glued together. It might have been because of block size or even timing issues in that particular CI run. Let me add a commit to swap to PrettyMonoBlock instead to make sure we always buffer and glue them together. I'll also merge master on top to make sure we're running the latest.

I ran 03727_named_tuples_pretty_format --test-run=10000 -j24 successfully to make sure it worked ok.

Remove trailing whitespaces added by GitHub web UI when solving the merge conflict

pamarcos · 2025-12-17T09:39:17Z

Thanks for working on this, @Sasao4o. Appreciate it 🫶

alexey-milovidov · 2025-12-17T17:05:19Z

@pamarcos, On the screenshots and in examples, I see an unbalanced space at the end.

pamarcos · 2025-12-17T18:31:24Z

@pamarcos, On the screenshots and in examples, I see an unbalanced space at the end.

You're absolutely right. I didn't see it because I thought the misalignment was due to the ↳, but there's also an extra whitespace 🙏

This should do it: #92421

Sasao4o · 2026-01-01T08:51:20Z

Thanks for working on this, @Sasao4o. Appreciate it 🫶

My pleasure, thanks for your review

Sasao4o added 2 commits December 8, 2025 00:47

Improve Pretty format: display named tuples as JSON

5486674

Add Test for NamedTuple in PrettyFormat

7ebd147

nihalzp added the can be tested Allows running workflows for external contributors label Dec 9, 2025

clickhouse-gh bot added the pr-improvement Pull request with some product improvements label Dec 9, 2025

nikitamikhaylov added the comp-formats Input/output formats (CSV/JSON/Parquet/ORC/Arrow/Protobuf/etc.). label Dec 12, 2025

pamarcos self-assigned this Dec 12, 2025

pamarcos requested a review from Copilot December 12, 2025 11:09

Copilot AI reviewed Dec 12, 2025

View reviewed changes

pamarcos requested changes Dec 12, 2025

View reviewed changes

src/DataTypes/Serializations/SerializationTuple.cpp Outdated Show resolved Hide resolved

src/Formats/FormatSettings.h Outdated Show resolved Hide resolved

pamarcos reviewed Dec 12, 2025

View reviewed changes

src/Processors/Formats/Impl/PrettyBlockOutputFormat.cpp Show resolved Hide resolved

Sasao4o added 7 commits December 13, 2025 00:36

Style Fix

5696202

Rename is_pretty_format to pretty_format

b252751

Merge remote-tracking branch 'upstream/master' into named-tuples-pret…

e405b6c

…ty-format

Add New FormatSetting output_format_pretty_named_tuples_as_json

c233482

Add backward compatibility for failed tests

b34f1c9

Fix Typo + Remove Whitespace

f4ea9a5

Add OrderBy To Ensure Determnistic test output

69b9d75

Improve Test (Remove UNION ALL)

bef0b5f

pamarcos added 3 commits December 15, 2025 16:56

Use PrettyMonoBlock to make sure rows are always glued together

b65f2f6

Merge branch 'master' into named-tuples-pretty-format

57f82b7

Merge branch 'master' into named-tuples-pretty-format

a81d8a9

pamarcos approved these changes Dec 16, 2025

View reviewed changes

Fix SettingsChangesHistory.cpp style

abbb03d

Remove trailing whitespaces added by GitHub web UI when solving the merge conflict

pamarcos added this pull request to the merge queue Dec 17, 2025

Merged via the queue into ClickHouse:master with commit 686e6fc Dec 17, 2025
122 of 131 checks passed

robot-clickhouse-ci-1 added the pr-synced-to-cloud The PR is synced to the cloud repo label Dec 17, 2025

pamarcos mentioned this pull request Dec 17, 2025

Fix unnecessary trailing whitespace in JSONPretty format #92421

Merged

1 task


		void SerializationTuple::serializeTextJSONPretty(const IColumn & column, size_t row_num, WriteBuffer & ostr, const FormatSettings & settings, size_t indent) const
		{

Conversation

Sasao4o commented Dec 9, 2025 • edited by pamarcos Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog category (leave one):

Changelog entry (a user-readable short description of the changes that goes into CHANGELOG.md):

Uh oh!

CLAassistant commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

clickhouse-gh bot commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sasao4o commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

pamarcos commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Sasao4o commented Dec 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pamarcos commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pamarcos commented Dec 17, 2025

Uh oh!

Uh oh!

alexey-milovidov commented Dec 17, 2025

Uh oh!

pamarcos commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sasao4o commented Jan 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Sasao4o commented Dec 9, 2025 •

edited by pamarcos

Loading

CLAassistant commented Dec 9, 2025 •

edited

Loading

clickhouse-gh bot commented Dec 9, 2025 •

edited

Loading

Sasao4o commented Dec 9, 2025 •

edited

Loading

pamarcos commented Dec 12, 2025 •

edited

Loading

Sasao4o commented Dec 14, 2025 •

edited

Loading

pamarcos commented Dec 15, 2025 •

edited

Loading

pamarcos commented Dec 17, 2025 •

edited

Loading