Google Git
Sign in
apache / iotdb-client-csharp / 4c12f5219de70a1b6570a41fb50dd3489c603203
commit4c12f5219de70a1b6570a41fb50dd3489c603203[log] [tgz]
authorZhan Lu <51200935+lausannel@users.noreply.github.com>Mon Mar 24 08:57:15 2025 +0000
committerGitHub <noreply@github.com>Mon Mar 24 16:57:15 2025 +0800
treec9cfa64d499914c7091edf4da0980214e79eb375
parent63e8016226940c92bc4487d440ccd4f7242b4ac9 [diff]
style: add pre commit hook for style check and format (#29)

* fix: fetch data fail due to different endpoint in SessionDataSet; update Docker configuration and .NET version; enhance command-line options

* fix typo

* style: add pre commit hook for every pr or commit and format code style

* add license check ignore for pre commit check

* remove: delete obsolete iotdb symlink

* fix: add TMPDIR for pre-commit to avoid resolve permission issue

* fix: clean up dotnet temporary folder in pre-commit workflow
49 files changed
tree: c9cfa64d499914c7091edf4da0980214e79eb375
  1. .github/
  2. Apache-IoTDB-Client-CSharp-UserCase/
  3. docs/
  4. samples/
  5. src/
  6. tests/
  7. .asf.yaml
  8. .dockerignore
  9. .gitattributes
  10. .gitignore
  11. .licenserc.yaml
  12. .pre-commit-config.yaml
  13. Apache.IoTDB.sln
  14. docker-compose-2c2d.yml
  15. docker-compose.yml
  16. launchSettings.json
  17. LICENSE
  18. PUBLISH.md
  19. README.md
  20. README_ZH.md
README.md

English | 中文

Apache IoTDB Client for C#

E2E Tests License NuGet Version NuGet Downloads

Overview

This is the C# client of Apache IoTDB.

Apache IoTDB (Internet of Things Database) is a data management system for time series data, which can provide users specific services, such as, data collection, storage and analysis. Due to its light weight structure, high performance and usable features together with its seamless integration with the Hadoop and Spark ecology, IoTDB meets the requirements of massive dataset storage, high throughput data input, and complex data analysis in the industrial IoT field.

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

Installation

Install from NuGet Package

We have prepared a Nuget Package for C# users. Users can directly install the Apache IoTDB client using the .NET CLI. To install, simply run the following command in your command line:

dotnet add package Apache.IoTDB

For more details, visit the package on NuGet.

[!NOTE] The Apache.IoTDB package only supports versions greater than .net framework 4.6.1.

Prerequisites

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

How to Use the Client (Quick Start)

Users can quickly get started by referring to the use cases under the Apache-IoTDB-Client-CSharp-UserCase directory. These use cases serve as a useful resource for getting familiar with the client's functionality and capabilities.

For those who wish to delve deeper into the client's usage and explore more advanced features, the samples directory contains additional code samples.

Developer environment requirements for iotdb-client-csharp

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

OS

  • Linux, MacOS or other Unix-like OS
  • Windows + Bash (WSL, cygwin, Git Bash)

Command Line Tools

  • dotnet CLI
  • Thrift

Publish your own client on nuget.org

You can find out how to publish from this doc.