com.microsoft.azure.kusto.data

Interface StreamingClient

All Superinterfaces:

AutoCloseable, Closeable

public interface StreamingClient
extends Closeable

Method Summary

Modifier and Type	Method and Description
KustoOperationResult	execute(String command) Execute the provided command against the default database.
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.
KustoOperationResult	executeStreamingIngestFromBlob(String databaseName, String tableName, String blobUrl, ClientRequestProperties clientRequestProperties, String dataFormat, String ingestionMappingReference)
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.

Methods inherited from interface java.io.Closeable

close

Method Detail

executeStreamingIngest

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

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.

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:

DataClientException - An exception originating from a client activity

DataServiceException - An exception returned from the service

executeStreamingQuery

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

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

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:

DataClientException - An exception originating from a client activity

DataServiceException - An exception returned from the service

executeStreamingQuery

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

Throws:

DataServiceException

DataClientException

executeStreamingQuery

InputStream executeStreamingQuery(String command)
                           throws DataServiceException,
                                  DataClientException

Throws:

DataServiceException

DataClientException

execute

KustoOperationResult execute(String command)
                      throws DataServiceException,
                             DataClientException

Execute the provided command against the default database.

Parameters:

command - The command to execute

Returns:

KustoOperationResult object including the ingestion result

Throws:

DataClientException - An exception originating from a client activity

DataServiceException - An exception returned from the service

executeStreamingIngestFromBlob

KustoOperationResult executeStreamingIngestFromBlob(String databaseName,
                                                    String tableName,
                                                    String blobUrl,
                                                    ClientRequestProperties clientRequestProperties,
                                                    String dataFormat,
                                                    String ingestionMappingReference)
                                             throws DataServiceException,
                                                    DataClientException

Throws:

DataServiceException

DataClientException