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

Constructor Summary

Constructors
Modifier Constructor Description

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`ClickHouseRequest.Mutation`	`data(ClickHouseDeferredValue<ClickHouseInputStream> input)`	Loads data from input stream.
`ClickHouseRequest.Mutation`	`data(ClickHouseFile file)`	Loads data from given file which may or may not be compressed.
`ClickHouseRequest.Mutation`	`data(ClickHouseInputStream input)`	Loads data from input stream.
`ClickHouseRequest.Mutation`	`data(ClickHouseWriter writer)`	Sets custom writer for streaming.
`ClickHouseRequest.Mutation`	`data(InputStream input)`	Loads data from input stream.
`ClickHouseRequest.Mutation`	`data(String file)`	Loads data from given file which may or may not be compressed.
`ClickHouseRequest.Mutation`	`data(String file, ClickHouseCompression compression)`	Loads compressed data from given file.
`CompletableFuture<ClickHouseResponse>`	`execute()`	Executes the request.
`ClickHouseResponse`	`executeAndWait()`	Synchronous version of `ClickHouseRequest.execute()`.
`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.
`CompletableFuture<ClickHouseResponse>`	`send()`	Deprecated. will be removed in v0.3.3, please use `execute()` instead
`ClickHouseResponse`	`sendAndWait()`	Deprecated. will be removed in v0.3.3, please use `executeAndWait()` instead
`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, compressServerResponse, compressServerResponse, compressServerResponse, compressServerResponse, copy, decompressClientRequest, decompressClientRequest, decompressClientRequest, decompressClientRequest, executeWithinTransaction, executeWithinTransaction, external, external, getChangeListener, getClient, getConfig, getExternalTables, getFormat, getInputFormat, getInputStream, getManager, getOutputStream, getPreparedQuery, getQueryId, getServer, getServerListener, getSessionId, getSettings, getStatements, getStatements, getTransaction, hasInputStream, hasOutputStream, isSealed, isTransactional, manager, option, options, options, 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, use, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Mutation
```
protected Mutation(ClickHouseRequest<?> request,
                   boolean sealed)
```
- Method Detail
  - 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 streaming. This will create a piped stream between the writer and ClickHouse server.
    
    Parameters:
    
    writer - writer
    
    Returns:
    
    mutation request
  - data
```
public ClickHouseRequest.Mutation data(ClickHouseFile file)
```
    Loads data from given file which may or may not be compressed.
    
    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)
```
    Loads data from given file which may or may not be compressed.
    
    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 given file.
    
    Parameters:
    
    file - absolute or relative path of the file
    
    compression - compression algorithm, ClickHouseCompression.NONE means no compression
    
    Returns:
    
    mutation request
  - data
```
public ClickHouseRequest.Mutation data(InputStream input)
```
    Loads data from input stream.
    
    Parameters:
    
    input - input stream
    
    Returns:
    
    mutation request
  - data
```
public ClickHouseRequest.Mutation data(ClickHouseInputStream input)
```
    Loads data from input stream.
    
    Parameters:
    
    input - input stream
    
    Returns:
    
    mutation request
  - data
```
public ClickHouseRequest.Mutation data(ClickHouseDeferredValue<ClickHouseInputStream> input)
```
    Loads data from input stream.
    
    Parameters:
    
    input - input stream
    
    Returns:
    
    mutation request
  - execute
```
public CompletableFuture<ClickHouseResponse> execute()
```
    Description copied from class: ClickHouseRequest
    
    Executes the request. Same as client.execute(request.seal()).
    
    Overrides:
    
    execute in class ClickHouseRequest<ClickHouseRequest.Mutation>
    
    Returns:
    
    non-null future to get response
  - executeAndWait
```
public ClickHouseResponse executeAndWait()
                                  throws ClickHouseException
```
    Description copied from class: ClickHouseRequest
    
    Synchronous version of ClickHouseRequest.execute().
    
    Overrides:
    
    executeAndWait in class ClickHouseRequest<ClickHouseRequest.Mutation>
    
    Returns:
    
    non-null response
    
    Throws:
    
    ClickHouseException - when error occurred during execution
  - send
```
@Deprecated
public CompletableFuture<ClickHouseResponse> send()
```
    Deprecated.
    will be removed in v0.3.3, please use execute() instead
    
    Sends mutation request for execution. Same as client.execute(request.seal()).
    
    Returns:
    
    non-null future to get response
    
    Throws:
    
    CompletionException - when error occurred
  - sendAndWait
```
public ClickHouseResponse sendAndWait()
                               throws ClickHouseException
```
    Deprecated.
    will be removed in v0.3.3, please use executeAndWait() instead
    
    Synchronous version of send().
    
    Returns:
    
    non-null response
    
    Throws:
    
    ClickHouseException - when error occurred during execution
  - 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

Class ClickHouseRequest.Mutation

Nested Class Summary

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

Field Summary

Fields inherited from class com.clickhouse.client.ClickHouseRequest

Constructor Summary

Method Summary

Methods inherited from class com.clickhouse.client.ClickHouseRequest

Methods inherited from class java.lang.Object

Constructor Detail

Mutation

Method Detail

getQuery

format

data

data

data

data

data

data

data

execute

executeAndWait

send

sendAndWait

table

seal