Package com.microsoft.azure.kusto.data

Class ClientImpl

java.lang.Object

com.microsoft.azure.kusto.data.ClientImpl

All Implemented Interfaces:

Client, StreamingClient

public class ClientImpl
extends Object
implements Client, StreamingClient

Field Summary

Fields

Modifier and Type	Field	Description
static String	FEDERATED_SECURITY_SUFFIX
static String	JAVA_INGEST_ACTIVITY_TYPE_PREFIX
static String	MGMT_ENDPOINT_VERSION
static String	QUERY_ENDPOINT_VERSION
static String	STREAMING_VERSION

Constructor Summary

Constructors

Constructor	Description
ClientImpl(ConnectionStringBuilder csb)
ClientImpl(ConnectionStringBuilder csb, HttpClientProperties properties)
ClientImpl(ConnectionStringBuilder csb, org.apache.http.impl.client.CloseableHttpClient httpClient)

Method Summary

Modifier and Type	Method	Description
KustoOperationResult	execute(String command)	Execute the provided command against the default database.
KustoOperationResult	execute(String database, String command)
KustoOperationResult	execute(String database, String command, ClientRequestProperties properties)
KustoOperationResult	executeStreamingIngest(String database, String table, InputStream stream, ClientRequestProperties properties, String streamFormat, String mappingName, boolean leaveOpen)	Ingest data from a given stream directly into Kusto database.
InputStream	executeStreamingQuery(String command)
InputStream	executeStreamingQuery(String database, String command)
InputStream	executeStreamingQuery(String database, String command, ClientRequestProperties properties)	Query directly from Kusto database using streaming output.
String	executeToJsonResult(String command)
String	executeToJsonResult(String database, String command)
String	executeToJsonResult(String database, String command, ClientRequestProperties properties)
String	getClusterUrl()

Methods inherited from class java.lang.Object

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

Field Detail

MGMT_ENDPOINT_VERSION

public static final String MGMT_ENDPOINT_VERSION

See Also:

Constant Field Values

QUERY_ENDPOINT_VERSION

public static final String QUERY_ENDPOINT_VERSION

See Also:

Constant Field Values

STREAMING_VERSION

public static final String STREAMING_VERSION

See Also:

Constant Field Values

FEDERATED_SECURITY_SUFFIX

public static final String FEDERATED_SECURITY_SUFFIX

See Also:

Constant Field Values

JAVA_INGEST_ACTIVITY_TYPE_PREFIX

public static final String JAVA_INGEST_ACTIVITY_TYPE_PREFIX

See Also:

Constant Field Values

Constructor Detail

ClientImpl

public ClientImpl(ConnectionStringBuilder csb)
           throws URISyntaxException

Throws:

URISyntaxException

ClientImpl

public ClientImpl(ConnectionStringBuilder csb,
                  HttpClientProperties properties)
           throws URISyntaxException

Throws:

URISyntaxException

ClientImpl

public ClientImpl(ConnectionStringBuilder csb,
                  org.apache.http.impl.client.CloseableHttpClient httpClient)
           throws URISyntaxException

Throws:

URISyntaxException

Method Detail

execute

public KustoOperationResult execute(String command)
                             throws DataServiceException,
                                    DataClientException

Description copied from interface: StreamingClient

Execute the provided command against the default database.

Specified by:

execute in interface Client

Specified by:

execute in interface StreamingClient

Parameters:

command - The command to execute

Returns:

KustoOperationResult object including the ingestion result

Throws:

DataServiceException - An exception returned from the service

DataClientException - An exception originating from a client activity

execute

public KustoOperationResult execute(String database,
                                    String command)
                             throws DataServiceException,
                                    DataClientException

Specified by:

execute in interface Client

Throws:

DataServiceException

DataClientException

execute

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

Specified by:

execute in interface Client

Throws:

DataServiceException

DataClientException

executeToJsonResult

public String executeToJsonResult(String command)
                           throws DataServiceException,
                                  DataClientException

Specified by:

executeToJsonResult in interface Client

Throws:

DataServiceException

DataClientException

executeToJsonResult

public String executeToJsonResult(String database,
                                  String command)
                           throws DataServiceException,
                                  DataClientException

Specified by:

executeToJsonResult in interface Client

Throws:

DataServiceException

DataClientException

executeToJsonResult

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

Specified by:

executeToJsonResult in interface Client

Throws:

DataServiceException

DataClientException

executeStreamingIngest

public KustoOperationResult executeStreamingIngest(String database,
                                                   String table,
                                                   InputStream stream,
                                                   ClientRequestProperties properties,
                                                   String streamFormat,
                                                   String mappingName,
                                                   boolean leaveOpen)
                                            throws DataServiceException,
                                                   DataClientException

Description copied from interface: StreamingClient

Ingest data from a given stream directly into Kusto database.

This method ingests the data from a given stream directly into Kusto database, using streaming ingestion endpoint, with additional properties mentioned in ingestionProperties It is not recommended to use this method directly, but the StreamingIngestClient from the Ingest package.

Specified by:

executeStreamingIngest in interface StreamingClient

Parameters:

database - The target database to ingest to

table - The target table to ingest to

stream - An InputStream which holds the data

properties - Additional request headers of the ingestion request

streamFormat - The format of the data in the provided stream

mappingName - Pre-defined mapping reference. Required for Json and Avro formats

leaveOpen - Specifies if the given stream should be closed after reading or be left open

Returns:

KustoOperationResult object including the ingestion result

Throws:

DataServiceException - An exception returned from the service

DataClientException - An exception originating from a client activity

executeStreamingQuery

public InputStream executeStreamingQuery(String command)
                                  throws DataServiceException,
                                         DataClientException

Specified by:

executeStreamingQuery in interface StreamingClient

Throws:

DataServiceException

DataClientException

executeStreamingQuery

public InputStream executeStreamingQuery(String database,
                                         String command)
                                  throws DataServiceException,
                                         DataClientException

Specified by:

executeStreamingQuery in interface StreamingClient

Throws:

DataServiceException

DataClientException

executeStreamingQuery

public InputStream executeStreamingQuery(String database,
                                         String command,
                                         ClientRequestProperties properties)
                                  throws DataServiceException,
                                         DataClientException

Description copied from interface: StreamingClient

Query directly from Kusto database using streaming output.

This method queries the Kusto database into a stream, using streaming query endpoint, with additional properties mentioned in ingestionProperties

Specified by:

executeStreamingQuery in interface StreamingClient

Parameters:

database - The target database to query

command - The command (query or admin command) to execute

properties - Additional request headers of the ingestion request

Returns:

InputStream Streaming json result, which must be closed by the caller

Throws:

DataServiceException - An exception returned from the service

DataClientException - An exception originating from a client activity

getClusterUrl

public String getClusterUrl()