org.embulk.spi

Class Exec

java.lang.Object

org.embulk.spi.Exec

public class Exec
extends Object

Provides static access inside Embulk for plugins.

Some methods, getInjector, getModelManager, and newPlugin have been removed since v0.10.18.

If access to the removed methods is really needed, a plugin can technically call them via ExecInternal in embulk-core. It is the quickest way to catch-up with the latest Embulk v0.10. But once doing it, the plugin won't work with Embulk v0.9. To keep your plugin work for both, find another way to realize what you want.

Keeping on calling ExecInternal is strongly discouraged although it can be a short-term solution as shown above. Embulk does not guarantee any compatibility in embulk-core with plugins. The plugin may easily stop working at some point of Embulk versions. Do it at your own risk.

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
static BufferAllocator	getBufferAllocator() Returns the BufferAllocator instance.
static Logger	getLogger(Class<?> clazz) Deprecated. Call LoggerFactory.getLogger(Class) directly, instead.
static Logger	getLogger(String name) Deprecated. Call LoggerFactory.getLogger(String) directly, instead.
static PageBuilder	getPageBuilder(BufferAllocator allocator, Schema schema, PageOutput output) Returns a PageBuilder instance created for the parameters.
static PageReader	getPageReader(Schema schema) Returns a PageReader instance created for the parameter.
static TempFileSpace	getTempFileSpace() Returns a space for temporary files, a TempFileSpace instance corresponding to the registered ExecSession.
static Timestamp	getTransactionTime() Deprecated. Timestamp is deprecated.
static Instant	getTransactionTimeInstant() Returns the transaction time in Instant.
static boolean	isPreview() Returns true if the execution is in a preview mode.
static ConfigDiff	newConfigDiff() Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newConfigDiff.
static ConfigSource	newConfigSource() Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newConfigSource.
static TaskReport	newTaskReport() Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newTaskReport.
static TaskSource	newTaskSource() Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newTaskSource.
static ExecSession	session() Deprecated. Plugins are discouraged from getting the ExecSession instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

session

@Deprecated
public static ExecSession session()

Deprecated. Plugins are discouraged from getting the ExecSession instance.

Returns the registered ExecSession instance.

Since:

0.4.0

getTransactionTime

@Deprecated
public static Timestamp getTransactionTime()

Deprecated. Timestamp is deprecated.

Returns the transaction time in Timestamp.

Since:

0.6.17

getTransactionTimeInstant

public static Instant getTransactionTimeInstant()

Returns the transaction time in Instant.

Since:

0.10.14

getLogger

@Deprecated
public static Logger getLogger(String name)

Deprecated. Call LoggerFactory.getLogger(String) directly, instead.

Returns a SLF4J Logger instance named according to the name parameter.

Parameters:

name - the name of the Logger

Returns:

the Logger instance

Since:

0.4.0

getLogger

@Deprecated
public static Logger getLogger(Class<?> clazz)

Deprecated. Call LoggerFactory.getLogger(Class) directly, instead.

Returns a SLF4J Logger instance named corresponding to the class passed as parameter.

Parameters:

clazz - the returned Logger will be named after clazz

Returns:

the Logger instance

Since:

0.4.0

getBufferAllocator

public static BufferAllocator getBufferAllocator()

Returns the BufferAllocator instance.

Since:

0.4.0

getPageBuilder

public static PageBuilder getPageBuilder(BufferAllocator allocator,
                                         Schema schema,
                                         PageOutput output)

Returns a PageBuilder instance created for the parameters.

Since:

0.10.17

getPageReader

public static PageReader getPageReader(Schema schema)

Returns a PageReader instance created for the parameter.

Since:

0.10.17

newTaskReport

@Deprecated
public static TaskReport newTaskReport()

Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newTaskReport.

Creates a new empty TaskReport instance.

Since:

0.7.0

newConfigDiff

@Deprecated
public static ConfigDiff newConfigDiff()

Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newConfigDiff.

Creates a new empty ConfigDiff instance.

Since:

0.4.0

newConfigSource

@Deprecated
public static ConfigSource newConfigSource()

Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newConfigSource.

Creates a new empty ConfigSource instance.

Since:

0.4.0

newTaskSource

@Deprecated
public static TaskSource newTaskSource()

Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newTaskSource.

Creates a new empty TaskSource instance.

Since:

0.4.0

getTempFileSpace

public static TempFileSpace getTempFileSpace()

Returns a space for temporary files, a TempFileSpace instance corresponding to the registered ExecSession.

Since:

0.6.16

isPreview

public static boolean isPreview()

Returns true if the execution is in a preview mode.

Since:

0.4.4