com.microsoft.azure.kusto.ingest

Interface IngestClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

QueuedIngestClient

All Known Implementing Classes:

IngestClientBase, ManagedStreamingIngestClient, QueuedIngestClientImpl, StreamingIngestClient

public interface IngestClient
extends Closeable

Method Summary

Modifier and Type	Method and Description
IngestionResult	ingestFromBlob(BlobSourceInfo blobSourceInfo, IngestionProperties ingestionProperties) Ingest data from a blob storage into Kusto database.
IngestionResult	ingestFromFile(FileSourceInfo fileSourceInfo, IngestionProperties ingestionProperties) Ingest data from a file into Kusto database.
IngestionResult	ingestFromResultSet(ResultSetSourceInfo resultSetSourceInfo, IngestionProperties ingestionProperties) Ingest data from a Result Set into Kusto database.
IngestionResult	ingestFromStream(StreamSourceInfo streamSourceInfo, IngestionProperties ingestionProperties) Ingest data from an input stream, into Kusto database.

Methods inherited from interface java.io.Closeable

close

Method Detail

ingestFromFile

IngestionResult ingestFromFile(FileSourceInfo fileSourceInfo,
                               IngestionProperties ingestionProperties)
                        throws IngestionClientException,
                               IngestionServiceException

Ingest data from a file into Kusto database.

This method ingests the data from a given file, described in fileSourceInfo, into Kusto database, according to the properties mentioned in ingestionProperties

Parameters:

fileSourceInfo - The specific SourceInfo to be ingested

ingestionProperties - Settings used to customize the ingestion operation

Returns:

IngestionResult object including the ingestion result

Throws:

IngestionClientException - An exception originating from a client activity

IngestionServiceException - An exception returned from the service

See Also:

FileSourceInfo, IngestionProperties

ingestFromBlob

IngestionResult ingestFromBlob(BlobSourceInfo blobSourceInfo,
                               IngestionProperties ingestionProperties)
                        throws IngestionClientException,
                               IngestionServiceException

Ingest data from a blob storage into Kusto database.

This method ingests the data from a given blob, described in blobSourceInfo, into Kusto database, according to the properties mentioned in ingestionProperties

Parameters:

blobSourceInfo - The specific SourceInfo to be ingested

ingestionProperties - Settings used to customize the ingestion operation

Returns:

IngestionResult object including the ingestion result

Throws:

IngestionClientException - An exception originating from a client activity

IngestionServiceException - An exception returned from the service

See Also:

BlobSourceInfo, IngestionProperties

ingestFromResultSet

IngestionResult ingestFromResultSet(ResultSetSourceInfo resultSetSourceInfo,
                                    IngestionProperties ingestionProperties)
                             throws IngestionClientException,
                                    IngestionServiceException

Ingest data from a Result Set into Kusto database.

This method ingests the data from a given Result Set, described in resultSetSourceInfo, into Kusto database, according to the properties mentioned in ingestionProperties

Ingesting from ResultSet is equivalent to ingesting from a csv stream. The DataFormat should be empty or set to "csv", and the mapping, should it be provided, should be csv mapping.

Parameters:

resultSetSourceInfo - The specific SourceInfo to be ingested

ingestionProperties - Settings used to customize the ingestion operation

Returns:

IngestionResult object including the ingestion result

Throws:

IngestionClientException - An exception originating from a client activity

IngestionServiceException - An exception returned from the service

See Also:

ResultSetSourceInfo, IngestionProperties

ingestFromStream

IngestionResult ingestFromStream(StreamSourceInfo streamSourceInfo,
                                 IngestionProperties ingestionProperties)
                          throws IngestionClientException,
                                 IngestionServiceException

Ingest data from an input stream, into Kusto database.

This method ingests the data from a given input stream, described in streamSourceInfo, into Kusto database, according to the properties mentioned in ingestionProperties

Parameters:

streamSourceInfo - The specific SourceInfo to be ingested

ingestionProperties - Settings used to customize the ingestion operation

Returns:

IngestionResult object including the ingestion result

Throws:

IngestionClientException - An exception originating from a client activity

IngestionServiceException - An exception returned from the service

See Also:

StreamSourceInfo, IngestionProperties