Merge pull request #15443 from ucasFL/pretty_row_numbers

Add setting `output_format_pretty_row_numbers`

src/Core/Settings.h

@@ -469,6 +469,7 @@ class IColumn;
     M(Bool, output_format_enable_streaming, false, "Enable streaming in output formats that support it.", 0) \
     M(Bool, output_format_write_statistics, true, "Write statistics about read rows, bytes, time elapsed in suitable output formats.", 0) \
     M(Bool, allow_non_metadata_alters, true, "Allow to execute alters which affects not only tables metadata, but also data on disk", 0) \
+    M(Bool, output_format_pretty_row_numbers, false, "Add row numbers before each row for pretty output format", 0) \
 
 #define LIST_OF_SETTINGS(M)    \
     COMMON_SETTINGS(M)         \

src/Formats/FormatFactory.cpp

@@ -107,6 +107,7 @@ static FormatSettings getOutputFormatSetting(const Settings & settings, const Co
     format_settings.pretty.charset = settings.output_format_pretty_grid_charset.toString() == "ASCII" ?
                                      FormatSettings::Pretty::Charset::ASCII :
                                      FormatSettings::Pretty::Charset::UTF8;
+    format_settings.pretty.output_format_pretty_row_numbers = settings.output_format_pretty_row_numbers;
     format_settings.template_settings.resultset_format = settings.format_template_resultset;
     format_settings.template_settings.row_format = settings.format_template_row;
     format_settings.template_settings.row_between_delimiter = settings.format_template_rows_between_delimiter;

src/Formats/FormatSettings.h

@@ -45,6 +45,8 @@ struct FormatSettings
         UInt64 max_value_width = 10000;
         bool color = true;
 
+        bool output_format_pretty_row_numbers = false;
+
         enum class Charset
         {
             UTF8,

src/Processors/Formats/Impl/PrettyBlockOutputFormat.cpp

@@ -33,6 +33,10 @@ void PrettyBlockOutputFormat::calculateWidths(
     WidthsPerColumn & widths, Widths & max_padded_widths, Widths & name_widths)
 {
     size_t num_rows = std::min(chunk.getNumRows(), format_settings.pretty.max_rows);
+
+    /// len(num_rows) + len(". ")
+    row_number_width = std::floor(std::log10(num_rows)) + 3;
+
     size_t num_columns = chunk.getNumColumns();
     const auto & columns = chunk.getColumns();
 
@@ -196,9 +200,20 @@ void PrettyBlockOutputFormat::write(const Chunk & chunk, PortKind port_kind)
     std::string middle_values_separator_s = middle_values_separator.str();
     std::string bottom_separator_s = bottom_separator.str();
 
+    if (format_settings.pretty.output_format_pretty_row_numbers)
+    {
+        /// Write left blank
+        writeString(String(row_number_width, ' '), out);
+    }
     /// Output the block
     writeString(top_separator_s, out);
 
+    if (format_settings.pretty.output_format_pretty_row_numbers)
+    {
+        /// Write left blank
+        writeString(String(row_number_width, ' '), out);
+    }
+
     /// Names
     writeCString(grid_symbols.bold_bar, out);
     writeCString(" ", out);
@@ -238,12 +253,35 @@ void PrettyBlockOutputFormat::write(const Chunk & chunk, PortKind port_kind)
     writeCString(grid_symbols.bold_bar, out);
     writeCString("\n", out);
 
+    if (format_settings.pretty.output_format_pretty_row_numbers)
+    {
+        /// Write left blank
+        writeString(String(row_number_width, ' '), out);
+    }
     writeString(middle_names_separator_s, out);
 
     for (size_t i = 0; i < num_rows && total_rows + i < max_rows; ++i)
     {
         if (i != 0)
+        {
+            if (format_settings.pretty.output_format_pretty_row_numbers)
+            {
+                /// Write left blank
+                writeString(String(row_number_width, ' '), out);
+            }
             writeString(middle_values_separator_s, out);
+        }
+
+        if (format_settings.pretty.output_format_pretty_row_numbers)
+        {
+            // Write row number;
+            auto row_num_string = std::to_string(i + 1) + ". ";
+            for (size_t j = 0; j < row_number_width - row_num_string.size(); ++j)
+            {
+                writeCString(" ", out);
+            }
+            writeString(row_num_string, out);
+        }
 
         writeCString(grid_symbols.bar, out);
 
@@ -262,6 +300,11 @@ void PrettyBlockOutputFormat::write(const Chunk & chunk, PortKind port_kind)
         writeCString("\n", out);
     }
 
+    if (format_settings.pretty.output_format_pretty_row_numbers)
+    {
+        /// Write left blank
+        writeString(String(row_number_width, ' '), out);
+    }
     writeString(bottom_separator_s, out);
 
     total_rows += num_rows;

src/Processors/Formats/Impl/PrettyBlockOutputFormat.h

@@ -33,6 +33,8 @@ protected:
     size_t terminal_width = 0;
     bool suffix_written = false;
 
+    size_t row_number_width = 7; // "10000. "
+
     const FormatSettings format_settings;
 
     using Widths = PODArray<size_t>;

src/Processors/Formats/Impl/PrettyCompactBlockOutputFormat.cpp

@@ -69,6 +69,12 @@ void PrettyCompactBlockOutputFormat::writeHeader(
     const Widths & max_widths,
     const Widths & name_widths)
 {
+    if (format_settings.pretty.output_format_pretty_row_numbers)
+    {
+        /// Write left blank
+        writeString(String(row_number_width, ' '), out);
+    }
+
     const GridSymbols & grid_symbols = format_settings.pretty.charset == FormatSettings::Pretty::Charset::UTF8 ?
                                        utf8_grid_symbols :
                                        ascii_grid_symbols;
@@ -117,6 +123,12 @@ void PrettyCompactBlockOutputFormat::writeHeader(
 
 void PrettyCompactBlockOutputFormat::writeBottom(const Widths & max_widths)
 {
+    if (format_settings.pretty.output_format_pretty_row_numbers)
+    {
+        /// Write left blank
+        writeString(String(row_number_width, ' '), out);
+    }
+
     const GridSymbols & grid_symbols = format_settings.pretty.charset == FormatSettings::Pretty::Charset::UTF8 ?
                                        utf8_grid_symbols :
                                        ascii_grid_symbols;
@@ -144,6 +156,17 @@ void PrettyCompactBlockOutputFormat::writeRow(
     const WidthsPerColumn & widths,
     const Widths & max_widths)
 {
+    if (format_settings.pretty.output_format_pretty_row_numbers)
+    {
+        // Write row number;
+        auto row_num_string = std::to_string(row_num + 1) + ". ";
+        for (size_t i = 0; i < row_number_width - row_num_string.size(); ++i)
+        {
+            writeCString(" ", out);
+        }
+        writeString(row_num_string, out);
+    }
+
     const GridSymbols & grid_symbols = format_settings.pretty.charset == FormatSettings::Pretty::Charset::UTF8 ?
                                        utf8_grid_symbols :
                                        ascii_grid_symbols;

src/Processors/Formats/Impl/PrettySpaceBlockOutputFormat.cpp

@@ -29,6 +29,10 @@ void PrettySpaceBlockOutputFormat::write(const Chunk & chunk, PortKind port_kind
     Widths name_widths;
     calculateWidths(header, chunk, widths, max_widths, name_widths);
 
+    if (format_settings.pretty.output_format_pretty_row_numbers)
+    {
+        writeString(String(row_number_width, ' '), out);
+    }
     /// Names
     for (size_t i = 0; i < num_columns; ++i)
     {
@@ -66,6 +70,16 @@ void PrettySpaceBlockOutputFormat::write(const Chunk & chunk, PortKind port_kind
 
     for (size_t row = 0; row < num_rows && total_rows + row < max_rows; ++row)
     {
+        if (format_settings.pretty.output_format_pretty_row_numbers)
+        {
+            // Write row number;
+            auto row_num_string = std::to_string(row + 1) + ". ";
+            for (size_t i = 0; i < row_number_width - row_num_string.size(); ++i)
+            {
+                writeCString(" ", out);
+            }
+            writeString(row_num_string, out);
+        }
         for (size_t column = 0; column < num_columns; ++column)
         {
             if (column != 0)

tests/queries/0_stateless/01509_output_format_pretty_row_numbers.reference

+┏━━━━━━━━┓
+┃ number ┃
+┡━━━━━━━━┩
+│      0 │
+├────────┤
+│      1 │
+├────────┤
+│      2 │
+├────────┤
+│      3 │
+├────────┤
+│      4 │
+├────────┤
+│      5 │
+├────────┤
+│      6 │
+├────────┤
+│      7 │
+├────────┤
+│      8 │
+├────────┤
+│      9 │
+└────────┘
+┌─number─┐
+│      0 │
+│      1 │
+│      2 │
+│      3 │
+│      4 │
+│      5 │
+│      6 │
+│      7 │
+│      8 │
+│      9 │
+└────────┘
+┌─number─┐
+│      0 │
+│      1 │
+│      2 │
+│      3 │
+│      4 │
+│      5 │
+│      6 │
+│      7 │
+│      8 │
+│      9 │
+└────────┘
+┏━━━━━━━━┓
+┃ number ┃
+┡━━━━━━━━┩
+│      0 │
+├────────┤
+│      1 │
+├────────┤
+│      2 │
+├────────┤
+│      3 │
+├────────┤
+│      4 │
+├────────┤
+│      5 │
+├────────┤
+│      6 │
+├────────┤
+│      7 │
+├────────┤
+│      8 │
+├────────┤
+│      9 │
+└────────┘
+┌─number─┐
+│      0 │
+│      1 │
+│      2 │
+│      3 │
+│      4 │
+│      5 │
+│      6 │
+│      7 │
+│      8 │
+│      9 │
+└────────┘
+ number
+
+      0 
+      1 
+      2 
+      3 
+      4 
+      5 
+      6 
+      7 
+      8 
+      9 
+ number
+
+      0 
+      1 
+      2 
+      3 
+      4 
+      5 
+      6 
+      7 
+      8 
+      9 
+    ┏━━━━━━━━┓
+    ┃ number ┃
+    ┡━━━━━━━━┩
+ 1. │      0 │
+    ├────────┤
+ 2. │      1 │
+    ├────────┤
+ 3. │      2 │
+    ├────────┤
+ 4. │      3 │
+    ├────────┤
+ 5. │      4 │
+    ├────────┤
+ 6. │      5 │
+    ├────────┤
+ 7. │      6 │
+    ├────────┤
+ 8. │      7 │
+    ├────────┤
+ 9. │      8 │
+    ├────────┤
+10. │      9 │
+    └────────┘
+    ┌─number─┐
+ 1. │      0 │
+ 2. │      1 │
+ 3. │      2 │
+ 4. │      3 │
+ 5. │      4 │
+ 6. │      5 │
+ 7. │      6 │
+ 8. │      7 │
+ 9. │      8 │
+10. │      9 │
+    └────────┘
+    ┌─number─┐
+ 1. │      0 │
+ 2. │      1 │
+ 3. │      2 │
+ 4. │      3 │
+ 5. │      4 │
+ 6. │      5 │
+ 7. │      6 │
+ 8. │      7 │
+ 9. │      8 │
+10. │      9 │
+    └────────┘
+    ┏━━━━━━━━┓
+    ┃ number ┃
+    ┡━━━━━━━━┩
+ 1. │      0 │
+    ├────────┤
+ 2. │      1 │
+    ├────────┤
+ 3. │      2 │
+    ├────────┤
+ 4. │      3 │
+    ├────────┤
+ 5. │      4 │
+    ├────────┤
+ 6. │      5 │
+    ├────────┤
+ 7. │      6 │
+    ├────────┤
+ 8. │      7 │
+    ├────────┤
+ 9. │      8 │
+    ├────────┤
+10. │      9 │
+    └────────┘
+    ┌─number─┐
+ 1. │      0 │
+ 2. │      1 │
+ 3. │      2 │
+ 4. │      3 │
+ 5. │      4 │
+ 6. │      5 │
+ 7. │      6 │
+ 8. │      7 │
+ 9. │      8 │
+10. │      9 │
+    └────────┘
+     number
+
+ 1.       0 
+ 2.       1 
+ 3.       2 
+ 4.       3 
+ 5.       4 
+ 6.       5 
+ 7.       6 
+ 8.       7 
+ 9.       8 
+10.       9 
+     number
+
+ 1.       0 
+ 2.       1 
+ 3.       2 
+ 4.       3 
+ 5.       4 
+ 6.       5 
+ 7.       6 
+ 8.       7 
+ 9.       8 
+10.       9 

tests/queries/0_stateless/01509_output_format_pretty_row_numbers.sql

+SELECT * FROM numbers(10) FORMAT Pretty;
+SELECT * FROM numbers(10) FORMAT PrettyCompact;
+SELECT * FROM numbers(10) FORMAT PrettyCompactMonoBlock;
+SELECT * FROM numbers(10) FORMAT PrettyNoEscapes;
+SELECT * FROM numbers(10) FORMAT PrettyCompactNoEscapes;
+SELECT * FROM numbers(10) FORMAT PrettySpaceNoEscapes;
+SELECT * FROM numbers(10) FORMAT PrettySpace;
+SET output_format_pretty_row_numbers=1;
+SELECT * FROM numbers(10) FORMAT Pretty;
+SELECT * FROM numbers(10) FORMAT PrettyCompact;
+SELECT * FROM numbers(10) FORMAT PrettyCompactMonoBlock;
+SELECT * FROM numbers(10) FORMAT PrettyNoEscapes;
+SELECT * FROM numbers(10) FORMAT PrettyCompactNoEscapes;
+SELECT * FROM numbers(10) FORMAT PrettySpaceNoEscapes;
+SELECT * FROM numbers(10) FORMAT PrettySpace;