Interfaces et classes clientes Kusto.Ingest
Les interfaces et classes main dans la bibliothèque .NET Kusto Ingest sont les suivantes :
- Interface IKustoIngestClient : interface d’ingestion main
- Classe ExtendedKustoIngestClient : extensions de l’interface d’ingestion main
- classe KustoIngestFactory : fabrique de main pour les clients d’ingestion
- classe KustoIngestionProperties : classe utilisée pour fournir des propriétés d’ingestion courantes
- classe SourceOptions : options de gestion des données sources
- class IngestionMapping : classe utilisée pour décrire le mappage de données pour l’ingestion
- Enum DataSourceFormat : formats de source de données pris en charge. Par exemple, CSV ou JSON.
- Interface IKustoQueuedIngestClient : interface décrivant les opérations qui s’appliquent uniquement à l’ingestion en file d’attente
- Classe KustoQueuedIngestionProperties : propriétés qui s’appliquent uniquement à l’ingestion en file d’attente
Notes
Ces informations s’appliquent spécifiquement à la bibliothèque cliente .NET. Différentes bibliothèques clientes peuvent avoir des variations dans leurs interfaces et classes disponibles. Pour une compréhension plus large de Kusto Ingest dans toutes les bibliothèques clientes, consultez Vue d’ensemble de Kusto Ingest.
Interface 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);
}
Classe ExtendedKustoIngestClient
- IngestFromSingleBlob - Déconseillé. Utilisez
IKustoIngestClient.IngestFromStorageAsync
à la place. - IngestFromSingleBlobAsync - Déconseillé. Utilisez
IKustoIngestClient.IngestFromStorageAsync
à la place. - IngestFromDataReader - Déconseillé. Utilisez
IKustoIngestClient.IngestFromDataReaderAsync
à la place. - IngestFromDataReaderAsync
- IngestFromSingleFile - Déconseillé. Utilisez
IKustoIngestClient.IngestFromStorageAsync
à la place. - IngestFromSingleFileAsync - Déconseillé. Utilisez
IKustoIngestClient.IngestFromStorageAsync
à la place. - IngestFromStream - Déconseillé. Utilisez
IKustoIngestClient.IngestFromStreamAsync
à la place. - 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);
}
Classe 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);
}
Classe KustoIngestionProperties
La classe KustoIngestionProperties contient des propriétés d’ingestion de base pour un contrôle fin sur le processus d’ingestion.
Propriété | Signification |
---|---|
nom_base_de_données | Nom de la base de données dans laquelle ingérer |
TableName | Nom de la table dans laquelle ingérer |
DropByTags | Balises que chaque étendue aura. Les DropByTags sont permanents et peuvent être utilisés comme suit : .show table T extents where tags has 'some tag' ou .drop extents <| .show table T extents where tags has 'some tag' |
IngestByTags | Balises écrites par étendue. Peut être utilisé ultérieurement avec la IngestIfNotExists propriété pour éviter d’ingérer deux fois les mêmes données. Pour plus d’informations, consultez Étiquettes ingest-by:. |
IngestionMapping | Contient une référence à un mappage sortant ou une liste de mappages de colonnes |
AdditionalTags | Balises supplémentaires si nécessaire |
IngestIfNotExists | Liste des balises que vous ne souhaitez pas ingérer à nouveau (par table) |
ValidationPolicy | Définitions de validation des données. |
Format | Format des données ingérées |
AdditionalProperties | Autres propriétés passées en tant que propriétés d’ingestion à la commande d’ingestion. Les propriétés sont transmises, car toutes les propriétés d’ingestion ne sont pas représentées dans un membre distinct de cette classe |
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 de classe
SourceOptions et les classes dérivées encapsulent des informations supplémentaires et des options de gestion pour les données sources. Les spécificités diffèrent d’une source prise en charge
// 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 de classe
Contient une référence à un mappage existant ou une liste de mappages de colonnes.
Propriété | Signification |
---|---|
IngestionMappings | Mappages de colonnes, chacun décrivant les données de colonne cible et sa source |
IngestionMappingKind | Type de mappage décrit dans la propriété IngestionMappings : Csv, Json, Avro, Parquet, SStream, Orc, ApacheAvro ou W3CLogFile |
IngestionMappingReference | Nom de mappage précréé |
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)
}
Enum 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
}
Exemple de définition 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
};
Interface IKustoQueuedIngestClient
L’interface IKustoQueuedIngestClient ajoute des méthodes de suivi qui suivent le résultat de l’opération d’ingestion et expose RetryPolicy pour le client d’ingestion.
- 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; }
}
Classe KustoQueuedIngestionProperties
La classe KustoQueuedIngestionProperties étend KustoIngestionProperties avec plusieurs boutons de contrôle qui peuvent être utilisés pour affiner le comportement d’ingestion.
Propriété | Signification |
---|---|
Vidage immédiat | La valeur par défaut est false . Si la valeur est définie true sur , contourne le mécanisme d’agrégation du service Gestion des données |
IngestionReportLevel | Contrôle le niveau d’ingestion status de création de rapports (par défaut sur FailuresOnly ). Pour de bonnes performances et une utilisation du stockage, nous vous recommandons de ne pas définir IngestionReportLevel sur FailuresAndSuccesses |
IngestionReportMethod | Contrôle la cible de l’ingestion status la création de rapports. Les options disponibles sont les suivantes : File d’attente Azure, Table Azure ou les deux. La valeur par défaut est 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);
}
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour