org.embulk.spi

Interface OutputPlugin

public interface OutputPlugin

The main class that an Output Plugin implements.

An Output Plugin writes a sequence of data records in Pages read from an Input Plugin, or a Filter Plugin, into the configured destination.

Since:

0.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OutputPlugin.Control A controller of the following tasks provided from the Embulk core.

Method Summary

Modifier and Type	Method and Description
void	cleanup(TaskSource taskSource, Schema schema, int taskCount, List<TaskReport> successTaskReports) Cleans up resources used in the transaction.
TransactionalPageOutput	open(TaskSource taskSource, Schema schema, int taskIndex) Opens a TransactionalPageOutput instance that receives Pages from an Input Plugin, or a Filter Plugin, and writes them into the configured destination.
ConfigDiff	resume(TaskSource taskSource, Schema schema, int taskCount, OutputPlugin.Control control) Resumes an output transaction.
ConfigDiff	transaction(ConfigSource config, Schema schema, int taskCount, OutputPlugin.Control control) Processes the entire output transaction.

Method Detail

transaction

ConfigDiff transaction(ConfigSource config,
                       Schema schema,
                       int taskCount,
                       OutputPlugin.Control control)

Processes the entire output transaction.

Parameters:

config - a configuration for the Output Plugin given from a user

schema - Schema of the output

taskCount - the number of tasks

control - a controller of the following tasks provided from the Embulk core

Returns:

ConfigDiff to represent the difference the next incremental run

Since:

0.4.0

resume

ConfigDiff resume(TaskSource taskSource,
                  Schema schema,
                  int taskCount,
                  OutputPlugin.Control control)

Resumes an output transaction.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

schema - Schema of the output

taskCount - the number of tasks

control - a controller of the following tasks provided from the Embulk core

Returns:

ConfigDiff to represent the difference the next incremental run

Since:

0.4.0

cleanup

void cleanup(TaskSource taskSource,
             Schema schema,
             int taskCount,
             List<TaskReport> successTaskReports)

Cleans up resources used in the transaction.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

schema - Schema of the output

taskCount - the number of tasks

successTaskReports - reports of successful tasks

Since:

0.7.0

open

TransactionalPageOutput open(TaskSource taskSource,
                             Schema schema,
                             int taskIndex)

Opens a TransactionalPageOutput instance that receives Pages from an Input Plugin, or a Filter Plugin, and writes them into the configured destination.

It processes each output task.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

schema - Schema of the output

taskIndex - the index number of the task

Returns:

an implementation of TransactionalPageOutput that receives Pages from an Input Plugin, or a Filter Plugin, and writes them into the configured destination

Since:

0.4.0