README_ZH.md

English | 中文

Apache IoTDB C#语言客户端

概览

本仓库是Apache IoTDB的C#语言客户端,与其他语言支持相同语义的用户接口。

Apache IoTDB website: https://iotdb.apache.org

Apache IoTDB Github: https://github.com/apache/iotdb

如何安装

从NuGet Package安装

我们为CSharp用户准备了NuGet包，用户可直接通过.NET CLI进行客户端安装，NuGet包链接如下,命令行中运行如下命令即可完成安装

我们为 C# 用户准备了一个 Nuget 包。用户可以直接通过 .NET CLI 进行客户端安装。命令行中运行如下命令即可完成安装

dotnet add package Apache.IoTDB

详情请访问 NuGet 上的包。

Note

请注意，Apache.IoTDB这个包仅支持大于.net framework 4.6.1的版本。

环境准备

.NET SDK Version >= 5.0
.NET Framework >= 4.6.1 

如何使用 (快速上手)

用户可以通过参考Apache-IoTDB-Client-CSharp-UserCase目录下的用例快速入门。这些用例提供了客户端的基本功能和用法的参考。

对于希望深入了解客户端用法并探索更高级特性的用户，samples目录包含了额外的代码示例。

iotdb-client-csharp的开发者环境要求

.NET SDK Version >= 5.0
.NET Framework >= 4.6.1
ApacheThrift >= 0.14.1
NLog >= 4.7.9

操作系统

• Linux、MacOS 或其他类 Unix 系统
• Windows + Bash (WSL、cygwin、Git Bash)

命令行工具

• dotnet CLI
• Thrift

代码格式化

本项目使用 dotnet format 基于 .editorconfig 规则来强制执行一致的代码风格。

本地检查格式

dotnet format --verify-no-changes

自动修复格式问题

dotnet format

CI 流水线会在所有 Pull Request 上自动检查代码格式。请确保在提交 PR 之前代码格式正确。

在 nuget.org 上发布你自己的客户端

你可以在这个文档中找到如何发布