Skip to content

Commit 0d125bf

Browse files
committed
Update Flux Commands List
1 parent e44a0bd commit 0d125bf

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/flux/flux-commands.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ parent: Flux
55
nav_order: 2
66
---
77

8-
Available flux commands
8+
Available flux commands (With Release 1.1.2)
99
=======================
1010

1111
add-oreaggregation
@@ -341,7 +341,8 @@ find-fix-paths
341341
--------------
342342
- description: Finds all paths that have values that match the given pattern. Allows for regex. These paths can be used in a Fix to address fields.
343343
- signature: StreamReceiver -> String
344-
- java class: org.metafacture.metafix.FindFixPaths
344+
- [example in Playground](https://metafacture.org/playground/?example=find-fix-paths)
345+
- java class: [org.metafacture.metafix.FindFixPaths](https://github.com/metafacture/metafacture-fix/blob/master/metafix/src/main/java/org/metafacture/metafix/FindFixPaths.java )
345346

346347
fix
347348
---
@@ -428,7 +429,8 @@ list-fix-paths
428429
- description: Lists all paths found in the input records. These paths can be used in a Fix to address fields. Options: `count` (output occurence frequency of each path, sorted by highest frequency first; default: `true`), `template` (for formatting the internal triple structure; default: `${o} | ${s}` if count is true, else `${s}`)`index` (output individual repeated subfields and array elements with index numbers instead of '*'; default: `false`)
429430
- options: template (String), count (boolean), index (boolean)
430431
- signature: StreamReceiver -> String
431-
- java class: org.metafacture.metafix.ListFixPaths
432+
- [example in Playground](https://metafacture.org/playground/?example=list-fix-paths)
433+
- java class: [org.metafacture.metafix.ListFixPaths](https://github.com/metafacture/metafacture-fix/blob/master/metafix/src/main/java/org/metafacture/metafix/ListFixPaths.java )
432434

433435
list-fix-values
434436
---------------
@@ -539,15 +541,15 @@ object-to-literal
539541
open-file
540542
---------
541543
- description: Opens a file.
542-
- options: decompressconcatenated (boolean), encoding (String), compression (String)
544+
- options: decompressconcatenated (boolean), encoding (String), compression [NONE, AUTO, BZIP2, GZIP, PACK200, XZ]
543545
- signature: String -> Reader
544546
- [example in Playground](https://metafacture.org/playground/?example=open-file)
545547
- java class: [org.metafacture.io.FileOpener](https://github.com/metafacture/metafacture-core/blob/master/metafacture-io/src/main/java/org/metafacture/io/FileOpener.java)
546548

547549
open-http
548550
---------
549551
- description: Opens an HTTP resource. Supports setting HTTP header fields `Accept`, `Accept-Charset`, `Accept-Encoding`, `Content-Encoding` and `Content-Type`, as well as generic headers (separated by `\n`). Defaults: request `method` = `GET`, request `url` = `@-` (input data), request `body` = `@-` (input data) if request method supports body and input data not already used, `Accept` header (`accept`) = `*/*`, `Accept-Charset` header (`acceptcharset`) = `UTF-8`, `errorprefix` = `ERROR: `.
550-
- options: method [DELETE, GET, HEAD, OPTIONS, POST, PUT, TRACE], contentencoding (String), header (String), [deprecated] encoding (String), body (String), acceptcharset (String), acceptencoding (String), url (String), contenttype (String), accept (String), errorprefix (String)
552+
- options: method [DELETE, GET, HEAD, OPTIONS, POST, PUT, TRACE], contentencoding (String), header (String), [deprecated] encoding (String), body (String), acceptcharset (String), acceptencoding (String), url (String), accept (String), errorprefix (String), contenttype (String)
551553
- signature: String -> Reader
552554
- [example in Playground](https://metafacture.org/playground/?example=open-http)
553555
- java class: [org.metafacture.io.HttpOpener](https://github.com/metafacture/metafacture-core/blob/master/metafacture-io/src/main/java/org/metafacture/io/HttpOpener.java)
@@ -582,7 +584,7 @@ pass-through
582584
print
583585
-----
584586
- description: Writes objects to stdout
585-
- options: footer (String), header (String), encoding (String), compression (String), separator (String)
587+
- options: footer (String), header (String), encoding (String), compression [NONE, AUTO, BZIP2, GZIP, PACK200, XZ], separator (String)
586588
- signature: Object ->
587589
- [example in Playground](https://metafacture.org/playground/?example=print)
588590
- java class: [org.metafacture.io.ObjectStdoutWriter](https://github.com/metafacture/metafacture-core/blob/master/metafacture-io/src/main/java/org/metafacture/io/ObjectStdoutWriter.java)
@@ -759,7 +761,7 @@ write
759761
-----
760762
- description: Writes objects to stdout or a file
761763
- arguments: [stdout, PATH]
762-
- options: appendiffileexists (boolean), footer (String), header (String), encoding (String), compression [NONE, AUTO, BZIP2, GZIP, PACK200, XZ], separator (String)
764+
- options: appendiffileexists (boolean), footer (String), header (String), encoding (String), compression (String), separator (String)
763765
- signature: Object -> Void
764766
- java class: [org.metafacture.io.ObjectWriter](https://github.com/metafacture/metafacture-core/blob/master/metafacture-io/src/main/java/org/metafacture/io/ObjectWriter.java)
765767

0 commit comments

Comments
 (0)