Skip to content
This repository has been archived by the owner on May 17, 2019. It is now read-only.

add docs for csv formatter #144

Merged
merged 1 commit into from
Dec 15, 2014
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/_formatter_parameters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,22 @@ Output the value of a single field instead of the whole record. Often used in co
add_newline false # Optional, defaults to true. If there is a trailing "\n" already, set it "false"
message_key my_field # Optional, defaults to "message". The value of this field is outputted.

#### csv

Output the record as CSV/TSV:

:::text
"value1"[delimiter]"value2"[delimiter]"value3"\n

`csv` format supports the `delimiter` and `force_quotes` options.

:::text
format csv
fields field1,field2,field3
delimiter \t # Optional. "," is used by default.
force_quotes false # Optional. true is used by default. If false, value won't be framed by quotes.

For this format, the following common parameters are also supported.

INCLUDE: _formatter_common_parameters