Package com.clickhouse.data

Class ClickHouseDataStreamFactory

java.lang.Object

com.clickhouse.data.ClickHouseDataStreamFactory

public class ClickHouseDataStreamFactory
extends Object

Factory class for creating objects to handle data stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	ClickHouseDataStreamFactory.DefaultExecutors

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ERROR_NO_DESERIALIZER
protected static final String	ERROR_NO_SERIALIZER
protected static final String	ERROR_UNSUPPORTED_FORMAT

Constructor Summary

Constructors

Constructor	Description
ClickHouseDataStreamFactory()

Method Summary

Modifier and Type	Method	Description
final ClickHousePipedOutputStream	createPipedOutputStream(int bufferSize, int queueSize, int timeout)
ClickHousePipedOutputStream	createPipedOutputStream(int bufferSize, int queueSize, int timeout, ClickHouseWriter writer)
ClickHousePipedOutputStream	createPipedOutputStream(int bufferSize, int queueSize, int timeout, Runnable postCloseAction)
final ClickHousePipedOutputStream	createPipedOutputStream(ClickHouseDataConfig config)	Creates a piped output stream.
ClickHousePipedOutputStream	createPipedOutputStream(ClickHouseDataConfig config, ClickHouseWriter writer)	Creates a piped output stream.
ClickHousePipedOutputStream	createPipedOutputStream(ClickHouseDataConfig config, Runnable postCloseAction)	Creates a piped output stream.
ExecutorService	getExecutor()	Gets default executor service for running blocking tasks.
static ClickHouseDataStreamFactory	getInstance()	Gets instance of the factory class.
ClickHouseDataProcessor	getProcessor(ClickHouseDataConfig config, ClickHouseInputStream input, ClickHouseOutputStream output, Map<String,Serializable> settings, List<ClickHouseColumn> columns)	Gets data processor according to given ClickHouseDataConfig and settings.
ScheduledExecutorService	getScheduler()	Gets default scheduled executor service for scheduled tasks.
static void	handleCustomAction(Runnable postCloseAction)	Handles custom action.
<T> CompletableFuture<T>	runBlockingTask(Supplier<T> supplier)	Executes a blocking task using CompletableFuture.supplyAsync(Supplier) and custom ExecutorService.
ScheduledFuture<?>	scheduleTask(Runnable task, long delay, TimeUnit unit)	Schedules a task using ScheduledExecutorService.schedule(Runnable, long, TimeUnit) and custom ScheduledExecutorService.

Methods inherited from class java.lang.Object

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

Field Details

ERROR_NO_DESERIALIZER

protected static final String ERROR_NO_DESERIALIZER

See Also:

• Constant Field Values

ERROR_NO_SERIALIZER

protected static final String ERROR_NO_SERIALIZER

See Also:

• Constant Field Values

ERROR_UNSUPPORTED_FORMAT

protected static final String ERROR_UNSUPPORTED_FORMAT

See Also:

• Constant Field Values

Constructor Details

ClickHouseDataStreamFactory

public ClickHouseDataStreamFactory()

Method Details

handleCustomAction

public static void handleCustomAction(Runnable postCloseAction)
                               throws IOException

Handles custom action.

Parameters:

postCloseAction - post close action, could be null

Throws:

IOException - when failed to execute post close action

getInstance

public static ClickHouseDataStreamFactory getInstance()

Gets instance of the factory class.

Returns:

instance of the factory class

getExecutor

public ExecutorService getExecutor()

Gets default executor service for running blocking tasks.

Returns:

non-null executor service

getScheduler

public ScheduledExecutorService getScheduler()

Gets default scheduled executor service for scheduled tasks.

Returns:

non-null scheduled executor service

runBlockingTask

public <T> CompletableFuture<T> runBlockingTask(Supplier<T> supplier)

Executes a blocking task using CompletableFuture.supplyAsync(Supplier) and custom ExecutorService.

Returns:

non-null future to get result

scheduleTask

public ScheduledFuture<?> scheduleTask(Runnable task,
 long delay,
 TimeUnit unit)

Schedules a task using ScheduledExecutorService.schedule(Runnable, long, TimeUnit) and custom ScheduledExecutorService.

Returns:

non-null future to get result

getProcessor

public ClickHouseDataProcessor getProcessor(ClickHouseDataConfig config,
 ClickHouseInputStream input,
 ClickHouseOutputStream output,
 Map<String,Serializable> settings,
 List<ClickHouseColumn> columns)
                                     throws IOException

Gets data processor according to given ClickHouseDataConfig and settings.

Parameters:

config - non-null configuration containing information like ClickHouseFormat

input - input stream for deserialization, must not be null when output is null

output - output stream for serialization, must not be null when input is null

settings - nullable settings

columns - nullable list of columns

Returns:

data processor, which might be null

Throws:

IOException - when failed to read columns from input stream

createPipedOutputStream

public final ClickHousePipedOutputStream createPipedOutputStream(ClickHouseDataConfig config)

Creates a piped output stream.

Parameters:

config - non-null configuration

Returns:

piped output stream

createPipedOutputStream

public ClickHousePipedOutputStream createPipedOutputStream(ClickHouseDataConfig config,
 Runnable postCloseAction)

Creates a piped output stream.

Parameters:

config - non-null configuration

postCloseAction - custom action will be performed right after closing the output stream

Returns:

piped output stream

createPipedOutputStream

public ClickHousePipedOutputStream createPipedOutputStream(ClickHouseDataConfig config,
 ClickHouseWriter writer)

Creates a piped output stream.

Parameters:

config - non-null configuration

writer - non-null custom writer

Returns:

piped output stream

createPipedOutputStream

public final ClickHousePipedOutputStream createPipedOutputStream(int bufferSize,
 int queueSize,
 int timeout)

createPipedOutputStream

public ClickHousePipedOutputStream createPipedOutputStream(int bufferSize,
 int queueSize,
 int timeout,
 Runnable postCloseAction)

createPipedOutputStream

public ClickHousePipedOutputStream createPipedOutputStream(int bufferSize,
 int queueSize,
 int timeout,
 ClickHouseWriter writer)