Interfejsy i klasy klienta Kusto.Ingest
Główne interfejsy i klasy w bibliotece Kusto Ingest .NET to:
- Interfejs IKustoIngestClient: główny interfejs pozyskiwania
- Class ExtendedKustoIngestClient: Rozszerzenia do głównego interfejsu pozyskiwania
- klasa KustoIngestFactory: główna fabryka klientów pozyskiwania
- class KustoIngestionProperties: Klasa używana do udostępniania typowych właściwości pozyskiwania
- class SourceOptions: Opcje obsługi danych źródłowych
- class IngestionMapping: Klasa używana do opisywania mapowania danych na potrzeby pozyskiwania
- Enum DataSourceFormat: obsługiwane formaty źródeł danych. Na przykład CSV lub JSON.
- Interfejs IKustoQueuedIngestClient: interfejs opisujący operacje stosowane tylko do pozyskiwania w kolejce
- Klasa KustoQueuedIngestionProperties: właściwości, które mają zastosowanie tylko do pozyskiwania w kolejce
Uwaga
Te informacje dotyczą konkretnie biblioteki klienta platformy .NET. Różne biblioteki klienckie mogą mieć odmiany dostępnych interfejsów i klas. Aby uzyskać szerszą wiedzę na temat pozyskiwania usługi Kusto we wszystkich bibliotekach klienckich, zobacz Omówienie pozyskiwania kusto.
Interfejs IKustoIngestClient
- IngestFromDataReaderAsync
- IngestFromStorageAsync
- IngestFromStreamAsync
public interface IKustoIngestClient : IDisposable
{
/// <summary>
/// Ingests data from <see cref="IDataReader"/>. <paramref name="dataReader"/> will be closed when the call completes.
/// </summary>
/// <param name="dataReader">The <see cref="IDataReader"/> data source to ingest. Only the first record set will be used</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <param name="sourceOptions">Options for the <see cref="IDataReader"/> ingestion source. This is an optional parameter</param>
/// <returns>An <see cref="IKustoIngestionResult"/> task</returns>
Task<IKustoIngestionResult> IngestFromDataReaderAsync(IDataReader dataReader, KustoIngestionProperties ingestionProperties, DataReaderSourceOptions sourceOptions = null);
/// <summary>
/// Ingest data from one of the supported storage providers. Currently the supported providers are: File System, Azure Blob Storage.
/// </summary>
/// <param name="uri">The URI of the storage resource to be ingested. Note: This URI may include a storage account key or shared access signature (SAS).
/// See <see href="https://learn.microsoft.com/azure/kusto/api/connection-strings/storage"/> for the URI format options.</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <param name="sourceOptions">Options for the storage ingestion source. This is an optional parameter</param>
/// <returns>An <see cref="IKustoIngestionResult"/> task</returns>
Task<IKustoIngestionResult> IngestFromStorageAsync(string uri, KustoIngestionProperties ingestionProperties, StorageSourceOptions sourceOptions = null);
/// <summary>
/// Ingest data from <see cref="Stream"/>.
/// </summary>
/// <param name="stream">The <see cref="Stream"/> data source to ingest</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <param name="sourceOptions">Options for the <see cref="Stream"/> ingestion source. This is an optional parameter</param>
/// <returns>An <see cref="IKustoIngestionResult"/> task</returns>
Task<IKustoIngestionResult> IngestFromStreamAsync(Stream stream, KustoIngestionProperties ingestionProperties, StreamSourceOptions sourceOptions = null);
}
Class ExtendedKustoIngestClient
- IngestFromSingleBlob — przestarzałe. Zamiast tego użyj polecenia cmdlet
IKustoIngestClient.IngestFromStorageAsync
. - IngestFromSingleBlobAsync — przestarzałe. Zamiast tego użyj polecenia cmdlet
IKustoIngestClient.IngestFromStorageAsync
. - IngestFromDataReader — przestarzałe. Zamiast tego użyj polecenia cmdlet
IKustoIngestClient.IngestFromDataReaderAsync
. - IngestFromDataReaderAsync
- IngestFromSingleFile — przestarzałe. Zamiast tego użyj polecenia cmdlet
IKustoIngestClient.IngestFromStorageAsync
. - IngestFromSingleFileAsync — przestarzałe. Zamiast tego użyj polecenia cmdlet
IKustoIngestClient.IngestFromStorageAsync
. - IngestFromStream — przestarzałe. Zamiast tego użyj polecenia cmdlet
IKustoIngestClient.IngestFromStreamAsync
. - IngestFromStreamAsync
public static class ExtendedKustoIngestClient
{
/// <summary>
/// Ingest data from a single data blob
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="blobUri">The URI of the blob will be ingested</param>
/// <param name="deleteSourceOnSuccess">Indicates if the source blob should be deleted after a successful ingestion</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <param name="rawDataSize">The uncompressed raw data size</param>
/// <returns><see cref="IKustoIngestionResult"/></returns>
public static IKustoIngestionResult IngestFromSingleBlob(this IKustoIngestClient client, string blobUri, bool deleteSourceOnSuccess, KustoIngestionProperties ingestionProperties, long? rawDataSize = null);
/// <summary>
/// Ingest data from a single data blob asynchronously
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="blobUri">The URI of the blob will be ingested</param>
/// <param name="deleteSourceOnSuccess">Indicates if the source blob should be deleted after a successful ingestion</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <param name="rawDataSize">The uncompressed raw data size</param>
/// <returns>An <see cref="IKustoIngestionResult"/> task</returns>
public static Task<IKustoIngestionResult> IngestFromSingleBlobAsync(this IKustoIngestClient client, string blobUri, bool deleteSourceOnSuccess, KustoIngestionProperties ingestionProperties, long? rawDataSize = null);
/// <summary>
/// Ingest data from a single data blob
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="blobDescription"><see cref="BlobDescription"/> representing the blobs that will be ingested</param>
/// <param name="deleteSourceOnSuccess">Indicates if the source blob should be deleted after a successful ingestion</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <param name="rawDataSize">The uncompressed raw data size</param>
/// <returns><see cref="IKustoIngestionResult"/></returns>
public static IKustoIngestionResult IngestFromSingleBlob(this IKustoIngestClient client, BlobDescription blobDescription, bool deleteSourceOnSuccess, KustoIngestionProperties ingestionProperties, long? rawDataSize = null);
/// <summary>
/// Ingest data from a single data blob asynchronously
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="blobDescription"><see cref="BlobDescription"/> representing the blobs that will be ingested</param>
/// <param name="deleteSourceOnSuccess">Indicates if the source blob should be deleted after a successful ingestion</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <param name="rawDataSize">The uncompressed raw data size</param>
/// <returns>An <see cref="IKustoIngestionResult"/> task</returns>
public static Task<IKustoIngestionResult> IngestFromSingleBlobAsync(this IKustoIngestClient client, BlobDescription blobDescription, bool deleteSourceOnSuccess, KustoIngestionProperties ingestionProperties, long? rawDataSize = null);
/// <summary>
/// Ingest data from <see cref="IDataReader"/>, which is closed and disposed of upon call completion
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="dataReader">The data to ingest (only the first record set will be used)</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <returns><see cref="IKustoIngestionResult"/></returns>
public static IKustoIngestionResult IngestFromDataReader(this IKustoIngestClient client, IDataReader dataReader, KustoIngestionProperties ingestionProperties);
/// <summary>
/// Asynchronously ingest data from <see cref="IDataReader"/>, which is closed and disposed of upon call completion
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="dataReader">The data to ingest (only the first record set will be used)</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <returns>An <see cref="IKustoIngestionResult"/> task</returns>
public static Task<IKustoIngestionResult> IngestFromDataReaderAsync(this IKustoIngestClient client, IDataReader dataReader, KustoIngestionProperties ingestionProperties);
/// <summary>
/// Ingest data from <see cref="IDataReader"/>, which is closed and disposed of upon call completion
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="dataReaderDescription"><see cref="DataReaderDescription"/>Represents the data to ingest (only the first record set will be used)</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <returns><see cref="IKustoIngestionResult"/></returns>
public static IKustoIngestionResult IngestFromDataReader(this IKustoIngestClient client, DataReaderDescription dataReaderDescription, KustoIngestionProperties ingestionProperties);
/// <summary>
/// Asynchronously ingest data from <see cref="IDataReader"/>, which is closed and disposed of upon call completion
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="dataReaderDescription"><see cref="DataReaderDescription"/>Represents the data to ingest (only the first record set will be used)</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <returns>An <see cref="IKustoIngestionResult"/> task</returns>
public static Task<IKustoIngestionResult> IngestFromDataReaderAsync(this IKustoIngestClient client, DataReaderDescription dataReaderDescription, KustoIngestionProperties ingestionProperties);
/// <summary>
/// Ingest data from a single file
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="filePath">Absolute path of the source file to be ingested</param>
/// <param name="deleteSourceOnSuccess">Indicates if the source file should be deleted after a successful ingestion</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <returns><see cref="IKustoIngestionResult"/></returns>
public static IKustoIngestionResult IngestFromSingleFile(this IKustoIngestClient client, string filePath, bool deleteSourceOnSuccess, KustoIngestionProperties ingestionProperties);
/// <summary>
/// Ingest data from a single file asynchronously
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="filePath">Absolute path of the source file to be ingested</param>
/// <param name="deleteSourceOnSuccess">Indicates if the source file should be deleted after a successful ingestion</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <returns>An <see cref="IKustoIngestionResult"/> task</returns>
public static Task<IKustoIngestionResult> IngestFromSingleFileAsync(this IKustoIngestClient client, string filePath, bool deleteSourceOnSuccess, KustoIngestionProperties ingestionProperties);
/// <summary>
/// Ingest data from a single file
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="fileDescription"><see cref="FileDescription"/> representing the file that will be ingested</param>
/// <param name="deleteSourceOnSuccess">Indicates if the source file should be deleted after a successful ingestion</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <returns><see cref="IKustoIngestionResult"/></returns>
public static IKustoIngestionResult IngestFromSingleFile(this IKustoIngestClient client, FileDescription fileDescription, bool deleteSourceOnSuccess, KustoIngestionProperties ingestionProperties);
/// <summary>
/// Ingest data from a single file asynchronously
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="fileDescription"><see cref="FileDescription"/> representing the file that will be ingested</param>
/// <param name="deleteSourceOnSuccess">Indicates if the source file should be deleted after a successful ingestion</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <returns>An <see cref="IKustoIngestionResult"/> task</returns>
public static Task<IKustoIngestionResult> IngestFromSingleFileAsync(this IKustoIngestClient client, FileDescription fileDescription, bool deleteSourceOnSuccess, KustoIngestionProperties ingestionProperties);
/// <summary>
/// Ingest data from <see cref="Stream"/>
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="stream">The data to ingest</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <param name="leaveOpen">Optional. If set to 'false' (default value), <paramref name="stream"/> will be closed and disposed on call completion</param>
/// <returns><see cref="IKustoIngestionResult"/></returns>
public static IKustoIngestionResult IngestFromStream(this IKustoIngestClient client, Stream stream, KustoIngestionProperties ingestionProperties, bool leaveOpen = false);
/// <summary>
/// Ingest data from <see cref="Stream"/> asynchronously
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="stream">The data to ingest</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <param name="leaveOpen">Optional. If set to 'false' (default value), <paramref name="stream"/> will be closed and disposed on call completion</param>
/// <returns>An <see cref="IKustoIngestionResult"/> task</returns>
public static Task<IKustoIngestionResult> IngestFromStreamAsync(this IKustoIngestClient client, Stream stream, KustoIngestionProperties ingestionProperties, bool leaveOpen = false);
/// <summary>
/// Ingest data from <see cref="Stream"/>
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="streamDescription"><see cref="StreamDescription"/>Represents the data to ingest</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <param name="leaveOpen">Optional. If set to 'false' (default value), streamDescription.Stream will be closed and disposed on call completion</param>
/// <returns><see cref="IKustoIngestionResult"/></returns>
public static IKustoIngestionResult IngestFromStream(this IKustoIngestClient client, StreamDescription streamDescription, KustoIngestionProperties ingestionProperties, bool leaveOpen = false);
/// <summary>
/// Ingest data from <see cref="Stream"/> asynchronously
/// </summary>
/// <param name="client">The ingest client that will execute the ingestions</param>
/// <param name="streamDescription"><see cref="StreamDescription"/>Represents the data to ingest</param>
/// <param name="ingestionProperties">Additional properties to be used during the ingestion process</param>
/// <param name="leaveOpen">Optional. If set to 'false' (default value), streamDescription.Stream will be closed and disposed on call completion</param>
/// <returns>An <see cref="IKustoIngestionResult"/> task</returns>
public static Task<IKustoIngestionResult> IngestFromStreamAsync(this IKustoIngestClient client, StreamDescription streamDescription, KustoIngestionProperties ingestionProperties, bool leaveOpen = false);
}
Klasa KustoIngestFactory
- CreateDirectIngestClient
- CreateQueuedIngestClient
- CreateManagedStreamingIngestClient
- CreateStreamingIngestClient
/// <summary>
/// Factory for creating Kusto ingestion objects.
/// </summary>
public static class KustoIngestFactory
{
/// <summary>
/// Creates an implementation of <see cref="IKustoIngestClient"/> that communicates
/// directly with the Kusto engine service.
/// </summary>
/// <param name="kcsb">Indicates the connection to the Kusto engine service.</param>
/// <returns>An implementation of <see cref="IKustoIngestClient"/> that communicates
/// directly with the Kusto engine service.</returns>
/// <remarks>In most cases, it is preferred that ingestion be done using the
/// queued implementation of <see cref="IKustoIngestClient"/>. See <see cref="CreateQueuedIngestClient(KustoConnectionStringBuilder)"/>.</remarks>
public static IKustoIngestClient CreateDirectIngestClient(KustoConnectionStringBuilder kcsb);
/// <summary>
/// Creates an implementation of <see cref="IKustoIngestClient"/> that communicates
/// directly with the Kusto engine service.
/// </summary>
/// <param name="connectionString">Indicates the connection to the Kusto engine service.</param>
/// <returns>An implementation of <see cref="IKustoIngestClient"/> that communicates
/// directly with the Kusto engine service.</returns>
/// <remarks>In most cases, it is preferred that ingestion be done using the
/// queued implementation of <see cref="IKustoIngestClient"/>. See <see cref="CreateQueuedIngestClient(string)"/>.</remarks>
public static IKustoIngestClient CreateDirectIngestClient(string connectionString);
/// <summary>
/// Creates an implementation of <see cref="IKustoQueuedIngestClient"/> that communicates
/// with the Kusto ingestion service using a reliable queue.
/// </summary>
/// <param name="kcsb">Indicates the connection to the Kusto ingestion service.
/// Note that the ingestion service generally has a "ingest-" prefix in the
/// DNS host name part.</param>
/// <returns>An implementation of <see cref="IKustoQueuedIngestClient"/> that communicates
/// with the Kusto ingestion service using a reliable queue.</returns>
public static IKustoQueuedIngestClient CreateQueuedIngestClient(KustoConnectionStringBuilder kcsb);
/// <summary>
/// Creates an implementation of <see cref="IKustoQueuedIngestClient"/> that communicates
/// with the Kusto ingestion service using a reliable queue.
/// </summary>
/// <param name="connectionString">Indicates the connection to the Kusto ingestion service.
/// Note that the ingestion service generally has a "ingest-" prefix in the
/// DNS host name part.</param>
/// <returns>An implementation of <see cref="IKustoQueuedIngestClient"/> that communicates with the Kusto ingestion service using a reliable queue.</returns>
public static IKustoQueuedIngestClient CreateQueuedIngestClient(string connectionString);
/// <summary>
/// Creates an implementation of <see cref="IKustoIngestClient"/> that performs managed streaming ingestion
/// </summary>
/// <param name="engineKcsb">Indicates the connection to the Kusto engine service.</param>
/// <param name="dmKcsb">Indicates the connection to the Kusto data management service.</param>
/// <returns>An implementation of <see cref="IKustoIngestClient"/> that performs managed streaming ingestion</returns>
/// <remarks>Streaming ingestion is performed directy intto Kusto enginge cluster
/// and is optimized for low-latency ingestion of relatively small chunks of data.
/// If the streaming ingset doesn't succeed after several retries, queued ingestion will be performed.</remarks>
public static IKustoIngestClient CreateManagedStreamingIngestClient(KustoConnectionStringBuilder engineKcsb, KustoConnectionStringBuilder dmKcsb);
/// <summary>
/// Creates an implementation of <see cref="IKustoIngestClient"/> that performs managed streaming ingestion
/// </summary>
/// <param name="engineConnectionString">Indicates the connection to the Kusto engine service.</param>
/// <param name="dmConnectionString">Indicates the connection to the Kusto data management service.</param>
/// <returns>An implementation of <see cref="IKustoIngestClient"/> that performs managed streaming ingestion</returns>
/// <remarks>Streaming ingestion is performed directy intto Kusto enginge cluster
/// and is optimized for low-latency ingestion of relatively small chunks of data.
/// If the streaming ingset doesn't succeed after several retries, queued ingestion will be performed.</remarks>
public static IKustoIngestClient CreateManagedStreamingIngestClient(string engineConnectionString, string dmConnectionString);
/// <summary>
/// Creates an implementation of <see cref="IKustoIngestClient"/> that performs streaming ingestion
/// </summary>
/// <param name="kcsb">Indicates the connection to the Kusto engine service.</param>
/// <returns>An implementation of <see cref="IKustoIngestClient"/> that performs streaming ingestion</returns>
/// <remarks>Streaming ingestion is performed directy intto Kusto enginge cluster
/// and is optimized for low-latency ingestion of relatively small chunks of data</remarks>
public static IKustoIngestClient CreateStreamingIngestClient(KustoConnectionStringBuilder kcsb);
/// <summary>
/// Creates an implementation of <see cref="IKustoIngestClient"/> that performs streaming ingestion
/// </summary>
/// <param name="connectionString">Indicates the connection to the Kusto engine service.</param>
/// <returns>An implementation of <see cref="IKustoIngestClient"/> that performs streaming ingestion</returns>
/// <remarks>Streaming ingestion is performed directy into Kusto enginge cluster
/// and is optimized for low-latency ingestion of relatively small chunks of data</remarks>
public static IKustoIngestClient CreateStreamingIngestClient(string connectionString);
}
Klasa KustoIngestionProperties
Klasa KustoIngestionProperties zawiera podstawowe właściwości pozyskiwania w celu uzyskania dokładnej kontroli nad procesem pozyskiwania.
Właściwość | Znaczenie |
---|---|
DatabaseName | Nazwa bazy danych do pozyskiwania |
TableName | Nazwa tabeli do pozyskiwania |
DropByTags | Tagi, które będą miały każdy zakres. DropByTags są trwałe i mogą być używane w następujący sposób: .show table T extents where tags has 'some tag' lub .drop extents <| .show table T extents where tags has 'some tag' |
IngestByTags | Tagi zapisywane w każdym zakresie. Można później używać z właściwością , IngestIfNotExists aby uniknąć dwukrotnego pozyskiwania tych samych danych. Aby uzyskać więcej informacji, zobacz ingest-by: tags (Pozyskiwanie według tagów). |
IngestionMapping | Przechowuje odwołanie do mapowania zakończenia lub listy mapowań kolumn |
Dodatkowe tagi | Dodatkowe tagi zgodnie z potrzebami |
IngestIfNotExists | Lista tagów, których nie chcesz ponownie pozyskiwać (na tabelę) |
ValidationPolicy | Definicje weryfikacji danych. |
Format | Format pozyskiwanych danych |
Dodatkowe właściwości | Inne właściwości, które są przekazywane jako właściwości pozyskiwania do polecenia pozyskiwania. Właściwości są przekazywane, ponieważ nie wszystkie właściwości pozyskiwania są reprezentowane w osobnym elemencie członkowskim tej klasy |
public class KustoIngestionProperties
{
public string DatabaseName { get; set; }
public string TableName { get; set; }
public IEnumerable<string> DropByTags { get; set; }
public IEnumerable<string> IngestByTags { get; set; }
public IEnumerable<string> AdditionalTags { get; set; }
public IEnumerable<string> IngestIfNotExists { get; set; }
public IngestionMapping IngestionMapping { get; set; }
public ValidationPolicy ValidationPolicy { get; set; }
public DataSourceFormat? Format { get; set; }
public bool IgnoreSizeLimit { get; set; } // Determines whether the limit of 4GB per single ingestion source should be ignored. Defaults to false.
public IDictionary<string, string> AdditionalProperties { get; set; }
public KustoIngestionProperties(string databaseName, string tableName);
}
SourceOptions klasy
Klasy sourceOptions i pochodne hermetyzują dodatkowe informacje i opcje obsługi danych źródłowych. Specyfika różni się między obsługiwanymi źródłami
// Base class
public abstract class SourceOptions
{
public Guid SourceId { get; set; }; // Identifies the ingestion source
public bool Compress { get; set; }; // Determines whether data should be compressed before being uploaded.
}
// Represents a local file/blob/ADLSv2 file
public sealed class StorageSourceOptions : SourceOptions
{
public long? Size { get; set; }; // Uncompressed data size. Should be used to comunicate the file size to the service for efficient ingestion
public bool DeleteSourceOnSuccess { get; set; }; // Indicates whether the ingestion source should be deleted after successful ingestion. Defaults to 'false'. When set to 'true', will require the service to individually delete each blob, which could put extra pressure on the service.
public DataSourceCompressionType CompressionType { get; set; }; // Indicates compression used. Defaults to 'none'
}
IngestionMapping klasy
Zawiera odwołanie do istniejącego mapowania lub listy mapowań kolumn.
Właściwość | Znaczenie |
---|---|
IngestionMappings | Mapowania kolumn, z których każda opisuje dane kolumny docelowej i jej źródło |
IngestionMappingKind | Rodzaj mapowania opisanego we właściwości IngestionMappings — jeden z następujących elementów: Csv, Json, Avro, Parquet, SStream, Orc, ApacheAvro lub W3CLogFile |
IngestionMappingReference | Wstępnie utworzona nazwa mapowania |
public class IngestionMapping
{
public IEnumerable<ColumnMapping> IngestionMappings { get; set; }
public IngestionMappingKind IngestionMappingKind { get; set; }
public string IngestionMappingReference { get; set; }
public IngestionMapping()
public IngestionMapping(IngestionMapping ingestionMapping)
}
Wyliczenie DataSourceFormat
public enum DataSourceFormat
{
csv, // Data is in a CSV(-comma-separated values) format
tsv, // Data is in a TSV(-tab-separated values) format
scsv, // Data is in a SCSV(-semicolon-separated values) format
sohsv, // Data is in a SOHSV(-SOH (ASCII 1) separated values) format
psv, // Data is in a PSV (pipe-separated values) format
tsve, // Tab-separated value with '\' escaping character.
txt, // Each record is a line and has just one field
raw, // The entire stream/file/blob is a single record having a single field
json, // Data is in a JSON-line format (each line is record with a single JSON value)
multijson, // The data stream is a concatenation of JSON documents (property bags all)
avro, // Data is in a AVRO format
orc, // Data is in a ORC format
parquet, // Data is in a Parquet format
}
Przykład definicji kustoIngestionProperties
var guid = new Guid().ToString();
var kustoIngestionProperties = new KustoIngestionProperties("TargetDatabase", "TargetTable")
{
DropByTags = new List<string> { DateTime.Today.ToString() },
IngestByTags = new List<string> { guid },
AdditionalTags = new List<string> { "some tags" },
IngestIfNotExists = new List<string> { guid },
IngestionMapping = new IngestionMapping() {
IngestionMappingKind = Data.Ingestion.IngestionMappingKind.Csv,
IngestionMappings = new ColumnMapping[] { new ColumnMapping() {
ColumnName = "stringColumn",
Properties = new Dictionary<string, string>() {
{ MappingConsts.Ordinal, "1"} }
} },
},
ValidationPolicy = new ValidationPolicy { ValidationImplications = ValidationImplications.Fail, ValidationOptions = ValidationOptions.ValidateCsvInputConstantColumns },
Format = DataSourceFormat.csv
};
Interfejs IKustoQueuedIngestClient
Interfejs IKustoQueuedIngestClient dodaje metody śledzenia, które są zgodne z wynikiem operacji pozyskiwania i uwidacznia metodę RetryPolicy dla klienta pozyskiwania.
- PeekTopIngestionFailures
- GetAndDiscardTopIngestionFailures
- GetAndDiscardTopIngestionSuccesses
public interface IKustoQueuedIngestClient : IKustoIngestClient
{
/// <summary>
/// Peeks top (== oldest) ingestion failures
/// </summary>
/// <param name="messagesLimit">Maximum ingestion failures to peek. Default value peeks 32 messages.</param>
/// <returns>A task which its result contains IEnumerable of <see cref="IngestionFailure"/>. The received messages won't be discarded from the relevant azure queue.</returns>
Task<IEnumerable<IngestionFailure>> PeekTopIngestionFailures(int messagesLimit = -1);
/// <summary>
/// Returns and deletes top (== oldest) ingestion failure notifications
/// </summary>
/// <param name="messagesLimit">Maximum ingestion failure notifications to get. Default value peeks 32 messages.</param>
/// <returns>A task which its result contains IEnumerable of <see cref="IngestionFailure"/>. The received messages will be discarded from the relevant azure queue.</returns>
Task<IEnumerable<IngestionFailure>> GetAndDiscardTopIngestionFailures(int messagesLimit = -1);
/// <summary>
/// Returns and deletes top (== oldest) ingestion success notifications
/// </summary>
/// <param name="messagesLimit">Maximum ingestion success notifications to get. Default value peeks 32 messages.</param>
/// <returns>A task which its result contains IEnumerable of <see cref="IngestionSuccess"/>. The received messages will be discarded from the relevant azure queue.</returns>
Task<IEnumerable<IngestionSuccess>> GetAndDiscardTopIngestionSuccesses(int messagesLimit = -1);
/// <summary>
/// An implementation of IRetryPolicy that will be enforced on every ingest call,
/// which affects how the ingest client handles retrying on transient failures
/// </summary>
IRetryPolicy QueueRetryPolicy { get; set; }
}
Klasa KustoQueuedIngestionProperties
Klasa KustoQueuedIngestionProperties rozszerza właściwość KustoIngestionProperties za pomocą kilku pokrętł sterujących, których można użyć do dostosowania zachowania pozyskiwania.
Właściwość | Znaczenie |
---|---|
FlushImmediately | Wartość domyślna to false . Jeśli jest ustawiona wartość true , spowoduje obejście mechanizmu agregacji usługi Zarządzanie danymi |
IngestionReportLevel | Określa poziom raportowania stanu pozyskiwania (wartość domyślna to FailuresOnly ). Aby uzyskać dobrą wydajność i użycie magazynu, zalecamy, aby nie ustawić parametru IngestionReportLevel na FailuresAndSuccesses |
IngestionReportMethod | Steruje celem raportowania stanu pozyskiwania. Dostępne opcje to: Azure Queue, Azure Table lub oba te opcje. Wartość domyślna to Queue . |
public class KustoQueuedIngestionProperties : KustoIngestionProperties
{
/// <summary>
/// Allows to stop the batching phase and will cause to an immediate ingestion.
/// Defaults to 'false'.
/// </summary>
public bool FlushImmediately { get; set; }
/// <summary>
/// Controls the ingestion status report level.
/// Defaults to 'FailuresOnly'.
/// </summary>
public IngestionReportLevel ReportLevel { get; set; }
/// <summary>
/// Controls the target of the ingestion status reporting. Available options are Azure Queue, Azure Table, or both.
/// Defaults to 'Queue'.
/// </summary>
public IngestionReportMethod ReportMethod { get; set; }
/// <summary>
/// Controls the target of the ingestion status reporting. Available options are Azure Queue, Azure Table, or both.
/// Defaults to 'Queue'.
/// </summary>
public IngestionReportMethod ReportMethod;
public KustoQueuedIngestionProperties(string databaseName, string tableName);
}
Opinia
https://aka.ms/ContentUserFeedback.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla