io.md

Description:

io process plugin is intended for IO operations with text and files.

Generic parameters:

Param	Required	Type	Template	Default	Example
include	-	bool	-	false	true
require	-	array	-	[]	[1, 2]

Plugin parameters:

Param	Required	Type	Cred	Template	Text Template	Default	Example	Description
data_append	-	bool	-	+	-	false	true	If true data will be appended to datum fields (string, slice).
file_in	-	bool	-	+	-	false	true	Process input as files.
file_in_mode	-	string	-	+	-	"text"	"split"	Read input file as a whole text or split to lines.
file_in_pre	-	string	-	+	-	""	"_"	Add characters to the beginning of data.
file_in_post	-	string	-	+	-	""	"_"	Add characters to the end of data.
file_in_split	-	string	-	+	-	"\n"	"AAA"	Separation characters in split mode.
file_out	-	bool	-	+	-	false	true	Process output as files.
file_out_append	-	bool	-	+	-	false	true	If true data will be appended to a file.
file_out_mode	-	string	-	+	-	"text"	"split"	Write text/lines to output file.
file_out_pre	-	string	-	+	-	""	"*"	Add characters to the beginning of data.
file_out_post	-	string	-	+	-	""	"*"	Add characters to the end of data.
file_out_split	-	string	-	+	-	"\n"	"AAA"	Separation characters in split mode.
input	+	array	-	+	-	"[]"	["/path/to/file1", "just text"]	Set input as text, file paths or Datum field.
output	+	array	-	+	-	"[]"	["data.array0", "data.text0"]	Set output as text, file paths or Datum field.
text_mode	-	string	-	+	-	"text"	"split"	Read input data as a whole text or split to lines.
text_pre	-	string	-	+	-	""	"^"	Add characters to the beggining of data.
text_post	-	string	-	+	-	""	"^"	Add characters to the end of data.
text_split	-	string	-	+	-	"\n"	"AAA"	Separation characters in split mode.

Flow sample:

flow:
  name: "io-process-example"

  input:
    plugin: "rss"
    params:
      input: [ "http://feeds.dzone.com/home" ]
      force: true
      force_count: 10

  process:
    - id: 0
      plugin: "io"
      alias: "copy files"
      params:
        input: [ "/tmp/file1", "/tmp/file2" ]
        output: [ "/tmp/file1_copy", "/tmp/file2_copy" ]
        file_in: true
        file_out: true

    - id: 1
      plugin: "io"
      alias: "write data to files"
      params:
        input: [ "rss.categories", "rss.link" ]
        output: [ "/tmp/rss_categories", "/tmp/rss_link" ]
        file_out: true
        file_out_mode: "split"
        file_out_post: ";"

    - id: 2
      plugin: "io"
      alias: "write data to fields"
      params:
        input: [ "rss.categories", "rss.link" ]
        output: [ "data.array0", "data.text0" ]

    - id: 3
      plugin: "echo"
      alias: "show copied fields"
      params:
        input: [ "data.array0", "data.text0" ]

    - id: 4
      plugin: "io"
      alias: "read data from files"
      params:
        input: [ "/tmp/rss_categories", "/tmp/rss_link" ]
        output: [ "data.text1", "data.text2" ]
        file_in: true

    - id: 5
      plugin: "echo"
      alias: "show read files"
      params:
        input: [ "data.text1", "data.text2" ]