Package ru.yandex.clickhouse

Class Writer

java.lang.Object

ru.yandex.clickhouse.Writer

public class Writer
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClickHouseStatementImpl	statement

Method Summary

Modifier and Type	Method	Description
T	addDbParam(ClickHouseQueryParam param, String value)
Writer	data(File input)	Shortcut method for specifying a file as an input.
Writer	data(File input, ClickHouseFormat format)
Writer	data(File input, ClickHouseFormat format, ClickHouseCompression compression)
Writer	data(InputStream stream)	Specifies data input stream.
Writer	data(InputStream stream, ClickHouseFormat format)	Specifies data input stream, and the format to use.
Writer	data(InputStream stream, ClickHouseFormat format, ClickHouseCompression compression)
Writer	dataCompression(ClickHouseCompression compression)
Writer	format(ClickHouseFormat format)	Specifies format for further insert of data via send().
ClickHouseCompression	getCompression()
T	option(String key, String value)
T	options(Map<String,String> params)
T	removeDbParam(ClickHouseQueryParam param)
T	removeOption(String key)
void	send()	Method to call, when Writer is fully configured.
void	send(String sql, InputStream data, ClickHouseFormat format)	Allows to send stream of data to ClickHouse.
void	send(String sql, ClickHouseStreamCallback callback, ClickHouseFormat format)	Sends the data in RowBinary or in Native format.
void	sendToTable(String table, InputStream data, ClickHouseFormat format)	Convenient method for importing the data into table.
Writer	sql(String sql)	Set SQL for data insertion.
Writer	table(String table)	Set table name for data insertion.
T	withDbParams(Map<ClickHouseQueryParam,String> dbParams)

Methods inherited from class java.lang.Object

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

Field Detail

statement

protected final ClickHouseStatementImpl statement

Method Detail

format

public Writer format(ClickHouseFormat format)

Specifies format for further insert of data via send().

Parameters:

format - the format of the data to upload

Returns:

this writer instance

table

public Writer table(String table)

Set table name for data insertion.

Parameters:

table - name of the table to upload the data to

Returns:

this writer instance

sql

public Writer sql(String sql)

Set SQL for data insertion.

Parameters:

sql - in a form "INSERT INTO table_name [(X,Y,Z)] VALUES "

Returns:

this writer instance

data

public Writer data(InputStream stream)

Specifies data input stream.

Parameters:

stream - a stream providing the data to upload

Returns:

this writer instance

data

public Writer data(InputStream stream,
                   ClickHouseFormat format)

Specifies data input stream, and the format to use.

Parameters:

stream - a stream providing the data to upload

format - the format of the data to upload

Returns:

this writer instance

data

public Writer data(File input)

Shortcut method for specifying a file as an input.

Parameters:

input - the file to upload

Returns:

this writer instance

data

public Writer data(InputStream stream,
                   ClickHouseFormat format,
                   ClickHouseCompression compression)

data

public Writer data(File input,
                   ClickHouseFormat format,
                   ClickHouseCompression compression)

dataCompression

public Writer dataCompression(ClickHouseCompression compression)

data

public Writer data(File input,
                   ClickHouseFormat format)

send

public void send()
          throws SQLException

Method to call, when Writer is fully configured.

Throws:

SQLException

send

public void send(String sql,
                 InputStream data,
                 ClickHouseFormat format)
          throws SQLException

Allows to send stream of data to ClickHouse.

Parameters:

sql - in a form of "INSERT INTO table_name (X,Y,Z) VALUES "

data - where to read data from

format - format of data in InputStream

Throws:

SQLException - if the upload fails

sendToTable

public void sendToTable(String table,
                        InputStream data,
                        ClickHouseFormat format)
                 throws SQLException

Convenient method for importing the data into table.

Parameters:

table - table name

data - source data

format - format of data in InputStream

Throws:

SQLException - if the upload fails

send

public void send(String sql,
                 ClickHouseStreamCallback callback,
                 ClickHouseFormat format)
          throws SQLException

Sends the data in RowBinary or in Native format.

Parameters:

sql - the SQL statement to execute

callback - data source for the upload

format - the format to use, either RowBinary or Native

Throws:

SQLException - if the upload fails

getCompression

public ClickHouseCompression getCompression()

addDbParam

public T addDbParam(ClickHouseQueryParam param,
                    String value)

removeDbParam

public T removeDbParam(ClickHouseQueryParam param)

withDbParams

public T withDbParams(Map<ClickHouseQueryParam,String> dbParams)

options

public T options(Map<String,String> params)

option

public T option(String key,
                String value)

removeOption

public T removeOption(String key)