org.embulk.spi

Class ExecSession

java.lang.Object

org.embulk.spi.ExecSession

public abstract class ExecSession
extends Object

Provides access inside Embulk for plugins through a transactional session.

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

Accessing ExecSession from plugins is however discouraged though ExecSession is in embulk-api, so accessible from plugins.

Method Summary

Modifier and Type	Method and Description
abstract void	cleanup() Cleans up the session.
abstract ExecSession	forPreview() Clones this ExecSession instance in a preview mode.
abstract BufferAllocator	getBufferAllocator() Returns the BufferAllocator instance.
abstract Logger	getLogger(Class<?> clazz) Deprecated. Call LoggerFactory.getLogger(Class) directly, instead.
abstract Logger	getLogger(String name) Deprecated. Call LoggerFactory.getLogger(String) directly, instead.
abstract PageBuilder	getPageBuilder(BufferAllocator allocator, Schema schema, PageOutput output) Returns a PageBuilder instance created for the parameters.
abstract PageReader	getPageReader(Schema schema) Returns a PageReader instance created for the parameter.
abstract ConfigSource	getSessionExecConfig() Deprecated. Plugins should no longer use it. It would be removed.
abstract TempFileSpace	getTempFileSpace() Returns a space for temporary files, a TempFileSpace instance corresponding to the registered ExecSession.
abstract Timestamp	getTransactionTime() Deprecated. Timestamp is deprecated.
abstract Instant	getTransactionTimeInstant() Returns the transaction time in Instant.
abstract String	getTransactionTimeString() Returns the transaction time formatted as a String.
abstract boolean	isPreview() Returns true if the execution is in a preview mode.
abstract ConfigDiff	newConfigDiff() Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newConfigDiff.
abstract ConfigSource	newConfigSource() Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newConfigSource.
abstract TaskReport	newTaskReport() Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newTaskReport.
abstract TaskSource	newTaskSource() Deprecated. Recommended to start using embulk-util-config from plugins. Use its own newTaskSource.

Methods inherited from class java.lang.Object

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

Method Detail

forPreview

public abstract ExecSession forPreview()

Clones this ExecSession instance in a preview mode.

Since:

0.6.16

getSessionExecConfig

@Deprecated
public abstract ConfigSource getSessionExecConfig()

Deprecated. Plugins should no longer use it. It would be removed.

Returns a ConfigSource instance that includes transaction_time for the exec part.

Since:

0.6.16

getTransactionTime

@Deprecated
public abstract Timestamp getTransactionTime()

Deprecated. Timestamp is deprecated.

Returns the transaction time in Timestamp.

Since:

0.4.0

getTransactionTimeInstant

public abstract Instant getTransactionTimeInstant()

Returns the transaction time in Instant.

Since:

0.10.4

getTransactionTimeString

public abstract String getTransactionTimeString()

Returns the transaction time formatted as a String.

Since:

0.10.4

getLogger

@Deprecated
public abstract 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 abstract 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 abstract BufferAllocator getBufferAllocator()

Returns the BufferAllocator instance.

Since:

0.4.0

getPageBuilder

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

Returns a PageBuilder instance created for the parameters.

Since:

0.10.17

getPageReader

public abstract PageReader getPageReader(Schema schema)

Returns a PageReader instance created for the parameter.

Since:

0.10.17

newTaskReport

@Deprecated
public abstract 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 abstract 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 abstract 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 abstract 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 abstract TempFileSpace getTempFileSpace()

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

Since:

0.6.16

isPreview

public abstract boolean isPreview()

Returns true if the execution is in a preview mode.

Since:

0.4.4

cleanup

public abstract void cleanup()

Cleans up the session.

Since:

0.6.16