Skip to content

Commit 41a1a5c

Browse files
committed
Document added file writer options for print_record(). (#269)
1 parent 356a5e7 commit 41a1a5c

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -356,14 +356,16 @@ Parameters:
356356

357357
Options:
358358

359+
- `append`: Whether to open files in append mode if they exist. (Default: `false`)
359360
- `compression` (file output only): Compression mode. (Default: `auto`)
360361
- `destination`: Destination to write the record to; may include [format directives](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html#syntax) for counter and record ID (in that order). (Default: `stdout`)
361362
- `encoding` (file output only): Encoding used by the underlying writer. (Default: `UTF-8`)
362-
- `footer`: Footer which is output after the record. (Default: `\n`)
363-
- `header`: Header which is output before the record. (Default: Empty string)
363+
- `footer`: Footer which is written at the end of the output. (Default: `\n`)
364+
- `header`: Header which is written at the beginning of the output. (Default: Empty string)
364365
- `id`: Field name which contains the record ID; if found, will be available for inclusion in `prefix` and `destination`. (Default: `_id`)
365366
- `internal`: Whether to print the record's internal representation instead of JSON. (Default: `false`)
366367
- `pretty`: Whether to use pretty printing. (Default: `false`)
368+
- `separator`: Separator which is written after the record. (Default: `\n`)
367369

368370
```perl
369371
print_record(["<prefix>"][, <options>...])

0 commit comments

Comments
 (0)