influxdb-client-csharp

这个仓库包含用于InfluxDB 2.x和Flux的C#客户端库。InfluxDB 3.x用户应该使用轻量级的v3客户端库。InfluxDB 1.x用户应该使用v1客户端库。

为了便于迁移并获得一致的查询和写入体验，v2用户应考虑使用InfluxQL和v1客户端库。

• 功能特性
• 文档
• 使用方法
  • InfluxDB 2.x中的写入和查询
  • 使用管理API在InfluxDB 2.x中创建新的Bucket
  • InfluxDB 1.7+中的Flux查询
• 贡献
• 许可证

文档

本节包含客户端库文档的链接。

• 产品文档，入门指南
• 示例
• API参考
• 更新日志

功能特性

• 支持通过InfluxDB 1.7+ REST API（/api/v2/query端点）使用Flux语言进行查询
• InfluxDB 2.x客户端
  • 使用Flux语言查询数据
  • 使用以下方式写入数据
    • 行协议
    • 数据点
    • POCO
  • InfluxDB 2.x管理API客户端，用于管理
    • 源、桶
    • 任务
    • 授权
    • 健康检查
    • ...

使用方法

InfluxDB 2.x中的写入和查询

以下示例演示如何将数据写入InfluxDB 2.x并使用Flux语言读取它们：

安装

使用最新版本：

.Net CLI

dotnet add package InfluxDB.Client

或者使用包管理器

Install-Package InfluxDB.Client

using System;
using InfluxDB.Client;
using InfluxDB.Client.Api.Domain;
using InfluxDB.Client.Core;
using InfluxDB.Client.Writes;
using Task = System.Threading.Tasks.Task;

namespace Examples
{
    public static class QueriesWritesExample
    {
        private static readonly char[] Token = "".ToCharArray();

        public static async Task Main()
        {
            using var client = new InfluxDBClient("http://localhost:8086", Token);

            //
            // 写入数据
            //
            using (var writeApi = client.GetWriteApi())
            {
                //
                // 通过Point写入
                //
                var point = PointData.Measurement("temperature")
                    .Tag("location", "west")
                    .Field("value", 55D)
                    .Timestamp(DateTime.UtcNow.AddSeconds(-10), WritePrecision.Ns);
                
                writeApi.WritePoint(point, "bucket_name", "org_id");
                
                //
                // 通过行协议写入
                //
                writeApi.WriteRecord("temperature,location=north value=60.0", WritePrecision.Ns, "bucket_name", "org_id");
                
                //
                // 通过POCO写入
                //
                var temperature = new Temperature {Location = "south", Value = 62D, Time = DateTime.UtcNow};
                writeApi.WriteMeasurement(temperature, WritePrecision.Ns, "bucket_name", "org_id");
            }
            
            //
            // 查询数据
            //
            var flux = "from(bucket:\"temperature-sensors\") |> range(start: 0)";

            var fluxTables = await influxDBClient.GetQueryApi().QueryAsync(flux, "org_id");
            fluxTables.ForEach(fluxTable =>
            {
                var fluxRecords = fluxTable.Records;
                fluxRecords.ForEach(fluxRecord =>
                {
                    Console.WriteLine($"{fluxRecord.GetTime()}: {fluxRecord.GetValue()}");
                });
            });
        }
        
        [Measurement("temperature")]
        private class Temperature
        {
            [Column("location", IsTag = true)] public string? Location { get; set; }

            [Column("value")] public double Value { get; set; }

            [Column(IsTimestamp = true)] public DateTime Time { get; set; }
        }
    }
}

使用管理API在InfluxDB 2.x中创建新的Bucket

以下示例演示如何使用InfluxDB 2.x管理API。更多信息请参见客户端文档。

安装

使用最新版本：

.Net CLI

dotnet add package InfluxDB.Client

或者使用包管理器

Install-Package InfluxDB.Client

using System;
using System.Collections.Generic;
using System.Linq;
using InfluxDB.Client;
using InfluxDB.Client.Api.Domain;
using Task = System.Threading.Tasks.Task;

namespace Examples
{
    public static class ManagementExample
    {
        public static async Task Main()
        {
            const string url = "http://localhost:8086";
            const string token = "my-token";
            const string org = "my-org";
            
            using var client = new InfluxDBClient(url, token);

            // 查找指定名称的组织的ID（PermissionAPI需要组织的ID）。
            var orgId = (await client.GetOrganizationsApi().FindOrganizationsAsync(org: org)).First().Id;

            //
            // 创建数据保留时间设置为3,600秒的"iot_bucket"桶
            //
            var retention = new BucketRetentionRules(BucketRetentionRules.TypeEnum.Expire, 3600);

            var bucket = await client.GetBucketsApi().CreateBucketAsync("iot_bucket", retention, orgId);
//
// 创建访问"iot_bucket"的访问令牌
//
var resource = new PermissionResource(PermissionResource.TypeEnum.Buckets, bucket.Id, null, orgId);

// 读取权限
var read = new Permission(Permission.ActionEnum.Read, resource);

// 写入权限
var write = new Permission(Permission.ActionEnum.Write, resource);

var authorization = await client.GetAuthorizationsApi()
    .CreateAuthorizationAsync(orgId, new List<Permission> { read, write });

//
// 创建可用于写入"iot_bucket"的令牌
//
Console.WriteLine($"用于写入iot_bucket的授权令牌: {authorization.Token}");
        }
    }
}

InfluxDB 1.8 API 兼容性

InfluxDB 1.8.0引入了向前兼容的API，用于InfluxDB 2.x。这使您可以轻松地从InfluxDB 1.x迁移到InfluxDB 2.x云服务或开源版本。

以下是可用的向前兼容API：

详细信息请参见InfluxDB 1.8示例。

InfluxDB 1.7+中的Flux查询

以下示例演示了使用Flux语言进行查询。

安装

使用最新版本：

.Net CLI

dotnet add package InfluxDB.Client.Flux

或者使用包管理器

Install-Package InfluxDB.Client.Flux

using System;
using InfluxDB.Client.Flux;

namespace Examples
{
    public static class FluxExample
    {
        public static void Run()
        {
            using var client = new FluxClient("http://localhost:8086/");

            var fluxQuery = "from(bucket: \"telegraf\")\n"
                               + " |> filter(fn: (r) => (r[\"_measurement\"] == \"cpu\" AND r[\"_field\"] == \"usage_system\"))"
                               + " |> range(start: -1d)"
                               + " |> sample(n: 5, pos: 1)";

            client.QueryAsync(fluxQuery, record =>
                            {
                                // 处理Flux查询记录
                                Console.WriteLine(record.GetTime() + ": " + record.GetValue());
                            },
                            (error) =>
                            {
                                // 处理结果时的错误处理
                                Console.WriteLine(error.ToString());

                            }, () =>
                            {
                                // 完成时
                                Console.WriteLine("查询完成");
                            }).GetAwaiter().GetResult();
        }
    }
}

贡献

如果您想贡献代码，您可以通过GitHub fork仓库并向master分支发送拉取请求来实现。

许可证

InfluxDB 2.x客户端根据MIT许可证发布。