@aciesai/azure-kusto-ingest 中文文档教程

Question

Microsoft Azure Kusto Ingest Library for Node

Installation

npm 安装 azure-kusto-ingest

Quick Start

```javascript const IngestClient = require("azure-kusto-ingest").IngestClient; const IngestionProps = require("azure-kusto-ingest").IngestionProperties; const KustoConnectionStringBuilder = require("azure-kusto-data").KustoConnectionStringBuilder; const { DataFormat, JsonColumnMapping } = require("azure-kusto-ingest").IngestionPropertiesEnums;

const kcsb = KustoConnectionStringBuilder.withAadApplicationKeyAuthentication(https://ingest-${cluster}.kusto.windows.net, appId, appKey, authorityId);

const ingestionProps = new IngestionProps( { 数据库：“数据库”， 表：“表”， 格式：DataFormat.JSON, 摄取映射： new JsonColumnMapping("TargetColumn1", "$.sourceProp1"), new JsonColumnMapping("TargetColumn2", "$.sourceProp2"), 新的 JsonColumnMapping("TargetColumn3", "$.sourceProp3") } );

const ingestClient = new IngestClient( 凯斯博, ingestion道具 );

console.log("从文件中提取");

摄取（）；

异步函数摄取（）{ 尝试{ await ingestClient.ingestFromFile("file.json", null); } 抓住（错误）{ 控制台日志（错误）； } console.log("等待摄取状态..."); 等待 waitForStatus(); }

## Authentication
There are several authentication methods

### AAD App
The are two ways to authenticate is to use app id and key

1. Using app key

javascript const kcsb = KustoConnectionStringBuilder.withAadApplicationKeyAuthentication(https://ingest-${clusterName}.kusto.windows.net,'appid','appkey','authorityId');

1. Using a certificate:

javascript const kcsb = KustoConnectionStringBuilder.withAadApplicationCertificateAuthentication(https://ingest-${clusterName}.kusto.windows.net, 'appid', 'certificate', 'thumbprint', 'authorityId');

### Username/Password

javascript KustoConnectionStringBuilder.withAadUserPasswordAuthentication(https://${clusterName}.kusto.windows.net,'用户名','密码');

Authority is optional *when it can be inferred from the domain* ('user@microsoft.com' would make the authority 'microsoft.com'). 
In any case it is possible to pass the authority id

javascript KustoConnectionStringBuilder.withAadUserPasswordAuthentication(https://ingest-${clusterName}.kusto.windows.net,'username','password','authorityId');

### Device
Using this method will write a token to the console, which can be used to authenticate at https://login.microsoftonline.com/common/oauth2/deviceauth and will allow temporary access. 

**<!>It is not ment for production purposes<!>**

javascript // 将记录要使用的设备令牌和 url KustoConnectionStringBuilder.withAadDeviceAuthentication(https://${clusterName}.kusto.windows.net, authId);

// 如果你想对响应做你自己的事情，你可以传递一个回调 // 注意：代码仍然会阻塞，直到设备通过身份验证 KustoConnectionStringBuilder.withAadDeviceAuthentication(https://${clusterName}.kusto.windows.net, authId, (tokenResponse) => { // 你的代码，例如复制到剪贴板或在浏览器中打开 url console.log("打开 " + tokenResponse.verificationUrl + " 并使用 " + tokenResponse.userCode + " 代码进行授权。"); });

## Usage

A Quick Overview is available at https://docs.microsoft.com/en-us/azure/data-explorer/ingest-data-overview

Notice ingestion is done against the ingestion endpoint, which usually include `ingest-` prefix on the cluster name.

### Ingestion Properties
Ingestion Props are instructions for Kusto on how to process the data.

The easiest way to provide ingestion properties is to set them on the ingestion client like in the sample above.
It is also possible to pass them on each ingestion (will merge them with default props).

Example props:

javascript const ingestionProps = new IngestionProps( “数据库”， “桌子”， 数据格式.JSON, new JsonColumnMapping("TargetColumn1", "$.sourceProp1"), new JsonColumnMapping("TargetColumn2", "$.sourceProp2"), 新的 JsonColumnMapping("TargetColumn3", "$.sourceProp3") );

### Ingestion Sources
There are several methods of ingesting data into Kusto (Azure Data Explorer) using this library

#### From Stream

This is useful for cases you already have streams available (http respinse, file stream, etc..)

javascript 尝试{ 等待ingestClient.ingestFromStream（可读，空）； } 抓住（错误）{ 控制台日志（错误）； } console.log("从流中提取完成");

From File

摄取文件首先确保它被压缩（如果没有，它会在本地压缩它）然后发送它以供摄取

let blob = new BlobDescriptor(blobUri, size);
try{
    await ingestClient.ingestFromFile("file.json", null);
}
catch(err){
    console.log(err);
}

From Azure Storage Blob

可能最简单的方法是提供一个 uri（使用 SAS)。

let blob = new BlobDescriptor(blobUri, size);
try{
    await ingestClient.ingestFromBlob(blob, null);
}
catch(err){
    console.log(err);
}

Ingestion Status

可以使用状态队列跟踪摄取的状态。

启用很简单，只需将 reportLevel Ingestion Property 设置为 ReportLevel.FailuresAndSuccesses

例如：

```javascript const IngestClient = require("azure-kusto-ingest").IngestClient; const IngestStatusQueues = require("azure-kusto-ingest").IngestStatusQueues; const IngestionProps = require("azure-kusto-ingest").IngestionProperties; const { ReportLevel, ReportMethod } = require("azure-kusto-ingest").IngestionPropertiesEnums; const KustoConnectionStringBuilder = require("azure-kusto-data").KustoConnectionStringBuilder; const { DataFormat, JsonColumnMapping } = require("azure-kusto-ingest").IngestionPropertiesEnums; const fs = require("fs");

const ingestClient = new IngestClient( KustoConnectionStringBuilder.withAadApplicationKeyAuthentication(https://ingest-${clusterName}.kusto.windows.net, appId, appKey, authorityId), 新的 IngestionProps( “D b”， “桌子”， 数据格式.JSON, [ 新的 JsonColumnMapping("Id", "$.id"), new JsonColumnMapping("Type", "$.type"), new JsonColumnMapping("Value", "$.type"), ], 无效的， 无效的， 无效的， 无效的， 无效的， 空，
ReportLevel.FailuresAndSuccesses, ReportMethod.Queue) );

const statusQueues = new IngestStatusQueues(ingestClient);

异步函数 waitForStatus() { while (await statusQueues.failure.isEmpty() && await statusQueues.success.isEmpty()) { await new Promise((resolve) => { setTimeout(resolve, 1000); }); }

const successes = statusQueues.success.pop();
for (let success of successes) {
    console.log(JSON.stringify(success));
}

const failures = statusQueues.failure.pop()
for (let failure of failures) {
    console.log(JSON.stringify(failure));
}

}

异步函数 ingestFromFile() { 尝试{ await ingestClient.ingestFromFile("file.json", null); } 抓住（错误）{ 控制台日志（错误）； } console.log("等待摄取状态..."); 等待 waitForStatus(); }