com.microsoft.azure.kusto.data

Interface Client

All Known Implementing Classes:

BaseClient

public interface Client

A client for interacting with Kusto.

Method Summary

Modifier and Type	Method and Description
KustoOperationResult	executeMgmt(String command) Executes a management command against the default database.
KustoOperationResult	executeMgmt(String database, String command) Executes a management command against a specified database.
KustoOperationResult	executeMgmt(String database, String command, ClientRequestProperties properties) Executes a management command against a specified database with additional request properties.
reactor.core.publisher.Mono<KustoOperationResult>	executeMgmtAsync(String command) Executes a management command asynchronously against the default database.
reactor.core.publisher.Mono<KustoOperationResult>	executeMgmtAsync(String database, String command) Executes a management command asynchronously against a specified database.
reactor.core.publisher.Mono<KustoOperationResult>	executeMgmtAsync(String database, String command, ClientRequestProperties properties) Executes a management command asynchronously against a specified database with additional request properties.
KustoOperationResult	executeQuery(String query) Executes a query against the default database.
KustoOperationResult	executeQuery(String database, String query) Executes a query against the specified database.
KustoOperationResult	executeQuery(String database, String query, ClientRequestProperties properties) Executes a query against a specified database with additional request properties.
reactor.core.publisher.Mono<KustoOperationResult>	executeQueryAsync(String command) Executes a query against the default database.
reactor.core.publisher.Mono<KustoOperationResult>	executeQueryAsync(String database, String command) Executes a query against a specified database.
reactor.core.publisher.Mono<KustoOperationResult>	executeQueryAsync(String database, String command, ClientRequestProperties properties) Executes a query command asynchronously against a specified database with additional request properties.
String	executeToJsonResult(String database, String command, ClientRequestProperties properties) Executes a query command and returns the result as a JSON string.
reactor.core.publisher.Mono<String>	executeToJsonResultAsync(String database, String command, ClientRequestProperties properties) Executes a query command asynchronously and returns the result as a JSON string.

Method Detail

executeQuery

KustoOperationResult executeQuery(String query)
                           throws DataServiceException,
                                  DataClientException

Executes a query against the default database.

Parameters:

query - The query command to execute.

Returns:

The result of the query as a KustoOperationResult.

Throws:

DataServiceException - If there is an error from the service.

DataClientException - If there is an error on the client side.

executeQuery

KustoOperationResult executeQuery(String database,
                                  String query)
                           throws DataServiceException,
                                  DataClientException

Executes a query against the specified database.

Parameters:

database - The name of the database.

query - The query to execute.

Returns:

A KustoOperationResult with the result of the query.

Throws:

DataServiceException - If there is an error from the service.

DataClientException - If there is an error on the client side.

executeQuery

KustoOperationResult executeQuery(String database,
                                  String query,
                                  ClientRequestProperties properties)
                           throws DataServiceException,
                                  DataClientException

Executes a query against a specified database with additional request properties.

Parameters:

database - The name of the database.

query - The query query to execute.

properties - Additional request properties.

Returns:

A KustoOperationResult with the result of the query.

Throws:

DataServiceException - If there is an error from the service.

DataClientException - If there is an error on the client side.

executeQueryAsync

reactor.core.publisher.Mono<KustoOperationResult> executeQueryAsync(String command)

Executes a query against the default database.

Parameters:

command - The query to execute.

Returns:

A KustoOperationResult emitting the result of the query.

executeQueryAsync

reactor.core.publisher.Mono<KustoOperationResult> executeQueryAsync(String database,
                                                                    String command)

Executes a query against a specified database.

Parameters:

database - The name of the database.

command - The query command to execute.

Returns:

A KustoOperationResult with the result of the query.

executeQueryAsync

reactor.core.publisher.Mono<KustoOperationResult> executeQueryAsync(String database,
                                                                    String command,
                                                                    ClientRequestProperties properties)

Executes a query command asynchronously against a specified database with additional request properties.

Parameters:

database - The name of the database.

command - The query command to execute.

properties - Additional request properties.

Returns:

A Mono emitting the result of the query as a KustoOperationResult.

executeMgmt

KustoOperationResult executeMgmt(String command)
                          throws DataServiceException,
                                 DataClientException

Executes a management command against the default database.

Parameters:

command - The management command to execute.

Returns:

The result of the command as a KustoOperationResult.

Throws:

DataServiceException - If there is an error from the service.

DataClientException - If there is an error on the client side.

executeMgmt

KustoOperationResult executeMgmt(String database,
                                 String command)
                          throws DataServiceException,
                                 DataClientException

Executes a management command against a specified database.

Parameters:

database - The name of the database.

command - The management command to execute.

Returns:

The result of the command as a KustoOperationResult.

Throws:

DataServiceException - If there is an error from the service.

DataClientException - If there is an error on the client side.

executeMgmt

KustoOperationResult executeMgmt(String database,
                                 String command,
                                 ClientRequestProperties properties)
                          throws DataServiceException,
                                 DataClientException

Executes a management command against a specified database with additional request properties.

Parameters:

database - The name of the database.

command - The management command to execute.

properties - Additional request properties.

Returns:

The result of the command as a KustoOperationResult.

Throws:

DataServiceException - If there is an error from the service.

DataClientException - If there is an error on the client side.

executeMgmtAsync

reactor.core.publisher.Mono<KustoOperationResult> executeMgmtAsync(String command)

Executes a management command asynchronously against the default database.

Parameters:

command - The management command to execute.

Returns:

A Mono emitting the result of the command as a KustoOperationResult.

executeMgmtAsync

reactor.core.publisher.Mono<KustoOperationResult> executeMgmtAsync(String database,
                                                                   String command)

Executes a management command asynchronously against a specified database.

Parameters:

database - The name of the database.

command - The management command to execute.

Returns:

A Mono emitting the result of the command as a KustoOperationResult.

executeMgmtAsync

reactor.core.publisher.Mono<KustoOperationResult> executeMgmtAsync(String database,
                                                                   String command,
                                                                   ClientRequestProperties properties)

Executes a management command asynchronously against a specified database with additional request properties.

Parameters:

database - The name of the database.

command - The management command to execute.

properties - Additional request properties.

Returns:

A Mono emitting the result of the command as a KustoOperationResult.

executeToJsonResult

String executeToJsonResult(String database,
                           String command,
                           ClientRequestProperties properties)
                    throws DataServiceException,
                           DataClientException

Executes a query command and returns the result as a JSON string.

Parameters:

database - The name of the database.

command - The query command to execute.

properties - Additional request properties.

Returns:

The result of the query as a JSON string.

Throws:

DataServiceException - If there is an error from the service.

DataClientException - If there is an error on the client side.

executeToJsonResultAsync

reactor.core.publisher.Mono<String> executeToJsonResultAsync(String database,
                                                             String command,
                                                             ClientRequestProperties properties)

Executes a query command asynchronously and returns the result as a JSON string.

Parameters:

database - The name of the database.

command - The query command to execute.

properties - Additional request properties.

Returns:

A Mono emitting the result of the query as a JSON string.