yq/pkg/yqlib/doc/headers/encode-decode.md

21 lines
840 B
Markdown
Raw Normal View History

2021-11-03 02:54:09 +00:00
# Encoder / Decoder
2021-10-22 01:37:47 +00:00
Encode operators will take the piped in object structure and encode it as a string in the desired format. The decode operators do the opposite, they take a formatted string and decode it into the relevant object structure.
2021-10-22 03:55:58 +00:00
2021-10-26 03:33:57 +00:00
Note that you can optionally pass an indent value to the encode functions (see below).
2021-11-03 02:54:09 +00:00
These operators are useful to process yaml documents that have stringified embeded yaml/json/props in them.
2021-12-02 01:11:15 +00:00
| Format | Decode (from string) | Encode (to string) |
| --- | -- | --|
| Yaml | from_yaml | to_yaml(i)/@yaml |
| JSON | from_json | to_json(i)/@json |
| Properties | | to_props/@props |
| CSV | | to_csv/@csv |
| TSV | | to_tsv/@tsv |
CSV and TSV format both accept either a single array or scalars (representing a single row), or an array of array of scalars (representing multiple rows).