public interface FormatterPlugin
A Formatter Plugin formats a sequence of data records in PageOutput
from an Input Plugin, or a Filter
Plugin, into a set of byte buffers of FileOutput
for a File Output Plugin, or an Encoder Plugin.
Modifier and Type | Interface and Description |
---|---|
static interface |
FormatterPlugin.Control
A controller of the following tasks provided from the Embulk core.
|
Modifier and Type | Method and Description |
---|---|
org.embulk.spi.PageOutput |
open(org.embulk.config.TaskSource taskSource,
org.embulk.spi.Schema schema,
org.embulk.spi.FileOutput output)
Opens a
PageOutput instance that receives Page s from an Input Plugin, or
a Filter Plugin, and writes formatted output into FileOutput output in the parameter list
for a File Output Plugin, or an Encoder Plugin. |
void |
transaction(org.embulk.config.ConfigSource config,
org.embulk.spi.Schema schema,
FormatterPlugin.Control control)
Processes the entire formatting transaction.
|
void transaction(org.embulk.config.ConfigSource config, org.embulk.spi.Schema schema, FormatterPlugin.Control control)
config
- a configuration for the Formatter Plugin given from a userschema
- Schema
of the input for the formattercontrol
- a controller of the following tasks provided from the Embulk coreorg.embulk.spi.PageOutput open(org.embulk.config.TaskSource taskSource, org.embulk.spi.Schema schema, org.embulk.spi.FileOutput output)
PageOutput
instance that receives Page
s from an Input Plugin, or
a Filter Plugin, and writes formatted output into FileOutput
output
in the parameter list
for a File Output Plugin, or an Encoder Plugin.
It processes each formatting task.
taskSource
- a configuration processed for the task from ConfigSource
schema
- Schema
of the input for the formatteroutput
- FileOutput
to write formatted output so that the output is read from a File
Output Plugin, or an Encoder PluginPageOutput
that receives Page
s from an Input
Plugin, or a Filter Plugin, and writes formatted output into FileOutput
output
in the
parameter list for a File Output Plugin, or an Encoder Plugin