org.embulk.spi

Interface FileInputPlugin

public interface FileInputPlugin

The main class that a File Input Plugin implements.

A File Input Plugin reads file-like byte sequences from the configured source into a set of byte buffers Buffer of TransactionalFileInput.

Since:

0.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FileInputPlugin.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.
TransactionalFileInput	open(TaskSource taskSource, int taskIndex) Opens a TransactionalFileInput instance so that Buffers read from the configured source are read from a Parser Plugin, or a Decoder Plugin.
ConfigDiff	resume(TaskSource taskSource, int taskCount, FileInputPlugin.Control control) Resumes a file input transaction.
ConfigDiff	transaction(ConfigSource config, FileInputPlugin.Control control) Processes the entire file input transaction.

Method Detail

transaction

ConfigDiff transaction(ConfigSource config,
                       FileInputPlugin.Control control)

Processes the entire file input transaction.

Parameters:

config - a configuration for the File 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,
                  int taskCount,
                  FileInputPlugin.Control control)

Resumes a file input 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

TransactionalFileInput open(TaskSource taskSource,
                            int taskIndex)

Opens a TransactionalFileInput instance so that Buffers read from the configured source are read from a Parser Plugin, or a Decoder Plugin.

It processes each file input task.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

taskIndex - the index number of the task

Returns:

an implementation of TransactionalFileInput so that Buffers read from the configured source are read from a Parser Plugin, or a Decoder Plugin

Since:

0.4.0