Package com.clickhouse.client

Class ClickHouseRequest.Mutation

java.lang.Object

com.clickhouse.client.ClickHouseRequest<ClickHouseRequest.Mutation>

com.clickhouse.client.ClickHouseRequest.Mutation

All Implemented Interfaces:

Serializable

Enclosing class:

ClickHouseRequest<SelfT extends ClickHouseRequest<SelfT>>

public static class ClickHouseRequest.Mutation
extends ClickHouseRequest<ClickHouseRequest.Mutation>

Mutation request.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.clickhouse.client.ClickHouseRequest

ClickHouseRequest.Mutation

Field Summary

Fields inherited from class com.clickhouse.client.ClickHouseRequest

changeListener, config, externalTables, input, managerRef, namedParameters, options, output, preparedQuery, queryId, server, serverListener, serverRef, settings, sql, statements, txRef, writer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Mutation(ClickHouseRequest<?> request, boolean sealed)

Method Summary

Modifier and Type	Method	Description
ClickHouseRequest.Mutation	data(ClickHouseDeferredValue<ClickHouseInputStream> input)	Loads data from deferred input stream.
ClickHouseRequest.Mutation	data(ClickHouseInputStream input)	Loads data from input stream.
ClickHouseRequest.Mutation	data(ClickHousePassThruStream stream)	Loads data from the given pass-thru stream which may or may not be compressed.
ClickHouseRequest.Mutation	data(ClickHouseWriter writer)	Sets custom writer for writing uncompressed data, use data(ClickHousePassThruStream) when the data is compressed.
ClickHouseRequest.Mutation	data(InputStream input)	Loads data from input stream.
ClickHouseRequest.Mutation	data(String file)	Loads data from the given file.
ClickHouseRequest.Mutation	data(String file, ClickHouseCompression compression)	Loads compressed data from the given file.
ClickHouseRequest.Mutation	data(String file, ClickHouseCompression compression, int compressionLevel)	Loads compressed data from the given file.
ClickHouseRequest.Mutation	format(ClickHouseFormat format)	Sets format to be used for communication between server and client.
protected String	getQuery()	Gets query, either set by query() or table().
ClickHouseRequest.Mutation	seal()	Creates a sealed request, which is an immutable copy of the current request.
ClickHouseRequest.Mutation	table(String table, String queryId)	Sets target table and optionally query id.

Methods inherited from class com.clickhouse.client.ClickHouseRequest

addExternal, changeProperty, changeServer, checkSealed, clearSession, clearSettings, compressServerResponse, compressServerResponse, compressServerResponse, compressServerResponse, copy, decompressClientRequest, decompressClientRequest, decompressClientRequest, decompressClientRequest, execute, executeAndWait, executeWithinTransaction, executeWithinTransaction, external, external, freezeOptions, freezeSettings, getChangeListener, getClient, getConfig, getExternalTables, getFormat, getInputStream, getManager, getOutputStream, getPreparedQuery, getQueryId, getServer, getServerListener, getSessionId, getSetting, getSetting, getSettings, getStatements, getStatements, getTransaction, getWriter, hasInputStream, hasOption, hasOption, hasOutputStream, hasSetting, isSealed, isTransactional, manager, option, options, options, output, output, output, output, output, output, output, params, params, params, params, params, params, params, params, query, query, query, query, removeExternal, removeExternal, removeOption, removeSetting, reset, resetCache, session, session, session, session, set, set, setChangeListener, setServerListener, settings, table, transaction, transaction, transaction, unfreezeOptions, unfreezeSettings, use, write

Methods inherited from class java.lang.Object

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

Constructor Details

Mutation

protected Mutation(ClickHouseRequest<?> request,
 boolean sealed)

Method Details

getQuery

protected String getQuery()

Description copied from class: ClickHouseRequest

Gets query, either set by query() or table().

Overrides:

getQuery in class ClickHouseRequest<ClickHouseRequest.Mutation>

Returns:

sql query

format

public ClickHouseRequest.Mutation format(ClickHouseFormat format)

Description copied from class: ClickHouseRequest

Sets format to be used for communication between server and client.

Overrides:

format in class ClickHouseRequest<ClickHouseRequest.Mutation>

Parameters:

format - preferred format, null means reset to default

Returns:

the request itself

data

public ClickHouseRequest.Mutation data(ClickHouseWriter writer)

Sets custom writer for writing uncompressed data, use data(ClickHousePassThruStream) when the data is compressed. This will remove input stream set by other data(...) methods.

Parameters:

writer - writer

Returns:

mutation request

data

public ClickHouseRequest.Mutation data(ClickHousePassThruStream stream)

Loads data from the given pass-thru stream which may or may not be compressed. This will not only remove custom writer set by data(ClickHouseWriter), but may also update compression and format.

Parameters:

stream - pass-thru stream, could be a file and may or may not be compressed

Returns:

mutation request

data

public ClickHouseRequest.Mutation data(String file)

Loads data from the given file. It's same as data(ClickHouseFile.of(file)) if the file name implies compression algorithm and/or format(e.g. some_file.csv.gz). It fall back to data(InputStream) if no clue. This will remove custom writer set by data(ClickHouseWriter).

Parameters:

file - absolute or relative path of the file, file extension will be used to determine if it's compressed or not

Returns:

mutation request

data

public ClickHouseRequest.Mutation data(String file,
 ClickHouseCompression compression)

Loads compressed data from the given file. This will remove custom writer set by data(ClickHouseWriter).

Parameters:

file - absolute or relative path of the file

compression - compression algorithm, null or ClickHouseCompression.NONE means no compression

Returns:

mutation request

data

public ClickHouseRequest.Mutation data(String file,
 ClickHouseCompression compression,
 int compressionLevel)

Loads compressed data from the given file. This will remove custom writer set by data(ClickHouseWriter).

Parameters:

file - absolute or relative path of the file

compression - compression algorithm, null or ClickHouseCompression.NONE means no compression

compressionLevel - compression level, use com.clickhouse.data.ClickHouseDataConfig#DEFAULT_READ_COMPRESS_LEVEL to use recommended level for the algorithm

Returns:

mutation request

data

public ClickHouseRequest.Mutation data(InputStream input)

Loads data from input stream. This will remove custom writer set by data(ClickHouseWriter).

Parameters:

input - input stream

Returns:

mutation request

data

public ClickHouseRequest.Mutation data(ClickHouseInputStream input)

Loads data from input stream. This will remove custom writer set by data(ClickHouseWriter).

Parameters:

input - input stream

Returns:

mutation request

data

public ClickHouseRequest.Mutation data(ClickHouseDeferredValue<ClickHouseInputStream> input)

Loads data from deferred input stream. This will remove custom writer set by data(ClickHouseWriter).

Parameters:

input - input stream

Returns:

mutation request

table

public ClickHouseRequest.Mutation table(String table,
 String queryId)

Description copied from class: ClickHouseRequest

Sets target table and optionally query id. This will generate a query like SELECT * FROM [table] and override the one set by ClickHouseRequest.query(String, String).

Overrides:

table in class ClickHouseRequest<ClickHouseRequest.Mutation>

Parameters:

table - non-empty table name

queryId - query id, null means no query id

Returns:

the request itself

seal

public ClickHouseRequest.Mutation seal()

Description copied from class: ClickHouseRequest

Creates a sealed request, which is an immutable copy of the current request. Listeners won't be copied to the sealed instance, because it's immutable.

Overrides:

seal in class ClickHouseRequest<ClickHouseRequest.Mutation>

Returns:

sealed request, an immutable copy of the current request