Package com.clickhouse.client

Class ClickHouseDataStreamFactory

java.lang.Object

com.clickhouse.client.ClickHouseDataStreamFactory

public class ClickHouseDataStreamFactory
extends Object

Factory class for creating objects to handle data stream.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ClickHouseDataStreamFactory()

Method Summary

Modifier and Type	Method	Description
ClickHousePipedOutputStream	createPipedOutputStream(int bufferSize, int queueSize, int timeout, Runnable postCloseAction)
ClickHousePipedOutputStream	createPipedOutputStream(ClickHouseConfig config, Runnable postCloseAction)	Creates a piped output stream.
ClickHousePipedStream	createPipedStream(ClickHouseConfig config)	Deprecated. will be removed in v0.3.3, please use createPipedOutputStream(ClickHouseConfig, Runnable) instead
ClickHouseDeserializer<ClickHouseValue>	getDeserializer(ClickHouseFormat format)	Gets deserializer for the given data format.
static ClickHouseDataStreamFactory	getInstance()	Gets instance of the factory class.
ClickHouseDataProcessor	getProcessor(ClickHouseConfig config, ClickHouseInputStream input, ClickHouseOutputStream output, Map<String,Object> settings, List<ClickHouseColumn> columns)	Gets data processor according to given ClickHouseConfig and settings.
ClickHouseSerializer<ClickHouseValue>	getSerializer(ClickHouseFormat format)	Gets serializer for the given data format.

Methods inherited from class java.lang.Object

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

Field Detail

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 Detail

ClickHouseDataStreamFactory

public ClickHouseDataStreamFactory()

Method Detail

getInstance

public static ClickHouseDataStreamFactory getInstance()

Gets instance of the factory class.

Returns:

instance of the factory class

getProcessor

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

Gets data processor according to given ClickHouseConfig 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

getDeserializer

public ClickHouseDeserializer<ClickHouseValue> getDeserializer(ClickHouseFormat format)

Gets deserializer for the given data format.

Parameters:

format - data format, null means ClickHouseDefaults.FORMAT.getEffectiveDefaultValue()

Returns:

deserializer for the given data format

getSerializer

public ClickHouseSerializer<ClickHouseValue> getSerializer(ClickHouseFormat format)

Gets serializer for the given data format.

Parameters:

format - data format, null means ClickHouseDefaults.FORMAT.getEffectiveDefaultValue()

Returns:

serializer for the given data format

createPipedStream

@Deprecated
public ClickHousePipedStream createPipedStream(ClickHouseConfig config)

Deprecated.

will be removed in v0.3.3, please use createPipedOutputStream(ClickHouseConfig, Runnable) instead

Creates a piped stream.

Parameters:

config - non-null configuration

Returns:

piped stream

createPipedOutputStream

public ClickHousePipedOutputStream createPipedOutputStream(ClickHouseConfig 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(int bufferSize,
                                                           int queueSize,
                                                           int timeout,
                                                           Runnable postCloseAction)