org.embulk.spi

Interface InputPlugin

public interface InputPlugin

The main class that an Input Plugin implements.

An Input Plugin reads a sequence of data records from the configured source into PageOutput so that the read input is read from an Output Plugin, or a Filter Plugin.

Since:

0.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InputPlugin.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.
ConfigDiff	guess(ConfigSource config) Performs the guess for the partially configured input.
ConfigDiff	resume(TaskSource taskSource, Schema schema, int taskCount, InputPlugin.Control control) Resumes an input transaction.
TaskReport	run(TaskSource taskSource, Schema schema, int taskIndex, PageOutput output) Runs each input task.
ConfigDiff	transaction(ConfigSource config, InputPlugin.Control control) Processes the entire input transaction.

Method Detail

transaction

ConfigDiff transaction(ConfigSource config,
                       InputPlugin.Control control)

Processes the entire input transaction.

Parameters:

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

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,
                  InputPlugin.Control control)

Resumes an input transaction.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

schema - Schema of the input

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 input

taskCount - the number of tasks

successTaskReports - reports of successful tasks

Since:

0.7.0

run

TaskReport run(TaskSource taskSource,
               Schema schema,
               int taskIndex,
               PageOutput output)

Runs each input task.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

schema - Schema of the input

taskIndex - the index number of the task

output - PageOutput to write read input so that the input is read from an Output Plugin, or a Filter Plugin

Returns:

a report from the task

Since:

0.7.0

guess

ConfigDiff guess(ConfigSource config)

Performs the guess for the partially configured input.

Parameters:

config - a partial configuration for the Input Plugin given from a user

Returns:

a new configuration guessed based on config

Since:

0.4.0