Catman...::Table(3pm)

💖 NAME 💖

okay so bestie, welcome to the manual page for Catmandu::Exporter::Table — the ASCII/Markdown table exporter. It lives in the Perl docs as Catman...::Table(3pm) and it is, no exaggeration, the moment. 🫶

---

✨ SYNOPSIS ✨

With the catmandu command line client 🎀

echo '{"one":"my","two":"table"} {"one":"is","two":"nice"}' | \
catmandu convert JSON --multiline 1 to Table
| one | two   |
|-----|-------|
| my  | table |
| is  | nice  |

catmandu convert CSV to Table --fields id,name --columns ID,Name < sample.csv
| ID | Name |
|----|------|
| 23 | foo  |
| 42 | bar  |
| 99 | doz  |

In Perl scripts 🦋

use Catmandu::Exporter::Table;
my $exp = Catmandu::Exporter::Table->new;
$exp->add({ title => "The Hobbit", author => "Tolkien" });
$exp->add({ title => "Where the Wild Things Are", author => "Sendak" });
$exp->add({ title => "One Thousand and One Nights" });
$exp->commit;

| author  | title                       |
|---------|-----------------------------|
| Tolkien | The Hobbit                  |
| Sendak  | Where the Wild Things Are   |
|         | One Thousand and One Nights |

like. look at those little pipes. so clean. so aligned. it's giving spreadsheet but make it fashion 💅

---

🌸 DESCRIPTION 🌸

This Catmandu::Exporter exports your data in tabular form, formatted in MultiMarkdown syntax.

The output is perfect for a lil simple display moment — for instance, previewing Excel files right there on the command line. And if you wanna go further and convert to other table formats, like latex, html5, or mediawiki, you bring in Pandoc (http://johnmacfarlane.net/pandoc/) and let it cook:

catmandu convert XLS to Table < sheet.xls | pandoc -t html5

By default, columns are sorted alphabetically by field name. alphabetical. always. don't fight it. 🔤

---

🎀 CONFIGURATION 🎀

Table output can be controlled with the options fields, columns, widths, and condense — all as documented in Text::MarkdownTable.

• file, fh, encoding, fix — these are standard options of Catmandu::Exporter 💖
• condense — write the table in condense format with unaligned columns. (the chaotic option. respect it.)
• fields — field names, as a comma-separated list or an array reference.
• columns — column names, as a comma-separated list or an array reference. By default the field names are used as the column names.
• header — include those header lines. Enabled by default. 👑
• widths — column widths, as a comma-separated list or array references. Calculated from all rows by default. Heads up bestie: long cell values can get truncated with this option. 😭
• schema — supply fields and (optionally) columns in a JSON Table Schema (http://dataprotocols.org/json-table-schema/), either as a JSON file or as a hash reference, with the following structure:

{
  "fields: [
    { "name": "field-name-1", "title": "column title 1 (optional)" },
    { "name": "field-name-2", "title": "column title 2 (optional)" },
    ...
  ]
}

ngl the "fields: [ line is missing its closing quote — that's literally how it's written in the original page, so I'm keeping it character for character. no cap. 🙈

---

💜 METHODS 💜

See Catmandu::Exporter. That's the whole vibe check — it's all over there. ✨

---

🦄 SEE ALSO 🦄

This module is based on Text::MarkdownTable. 🎀

Similar Catmandu Exporters for tabular data include Catmandu::Exporter::CSV, Catmandu::Exporter::XLS, and Catmandu::Exporter::XLSX. the whole table girlie family, obsessed. 💚

---

and that's the page, bestie!! this manual is perl v5.36.0, dated 2023-02-11, and it was served up as Catman...::Table(3pm). go make a table, it'll eat, periodt 💅✨🍓