org.embulk.spi

Interface FileOutputPlugin

public interface FileOutputPlugin

The main class that a File Output Plugin implements.

A File Output Plugin writes file-like byte sequences from a Formatter Plugin, or an Encoder Plugin, into the configured destination.

Since:

0.4.0

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

transaction

ConfigDiff transaction(ConfigSource config,
                       int taskCount,
                       FileOutputPlugin.Control control)

Processes the entire file output transaction.

Parameters:

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

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,
                  int taskCount,
                  FileOutputPlugin.Control control)

Resumes a file output transaction.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

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,
             int taskCount,
             List<TaskReport> successTaskReports)

Cleans up resources used in the transaction.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

taskCount - the number of tasks

successTaskReports - reports of successful tasks

Since:

0.7.0

open

TransactionalFileOutput open(TaskSource taskSource,
                             int taskIndex)

Opens a TransactionalFileOutput instance that receives Buffers from a Formatter Plugin, or an Encoder Plugin, and writes them into the configured destination.

It processes each file output task.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

taskIndex - the index number of the task

Returns:

an implementation of TransactionalFileOutput that receives Buffers from a Formatter Plugin, or an Encoder Plugin, and writes them into the configured destination

Since:

0.4.0