Skip to content

README.md

Latest commit

 

History

History
150 lines (104 loc) · 5.62 KB

README.md

File metadata and controls

150 lines (104 loc) · 5.62 KB
Raw

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.

TLS and mTLS

Enable TLS by calling SetUseSsl(true). The C# client uses the .NET certificate model and does not read Java truststores directly. If your certificates were generated with the JDK 17 Java/keytool workflow, client.keystore is PKCS#12 by default and can be used directly as the client certificate file; use ca.crt directly as the trusted root.

keytool artifact C# client usage
ca.crt Pass to SetRootCertificatePath / RootCertificatePath to trust the server certificate
client.keystore Contains the client private key and client certificate; JDK 17 creates PKCS#12 by default, so pass it directly to SetClientCertificatePath
client.truststore Java client truststore; the C# client uses ca.crt instead
server.truststore Server-side truststore for trusting client certificates; not a C# client option

When RootCertificatePath is set, Host / DataSource must match the server certificate SAN. If you connect by IP address, the server certificate must include the corresponding IP SAN.

Only convert the keystore first if you are reusing an older JKS file, or if it was explicitly generated with -storetype JKS:

$KT -importkeystore \
  -srckeystore client.keystore \
  -srcstorepass $PWD \
  -srcalias client \
  -destkeystore client.p12 \
  -deststoretype PKCS12 \
  -deststorepass $PWD \
  -destkeypass $PWD \
  -destalias client

C# builder example:

var sessionPool = new SessionPool.Builder()
    .SetHost("127.0.0.1")
    .SetPort(6667)
    .SetUseSsl(true)
    .SetRootCertificatePath("tls-certs/ca.crt")
    .SetClientCertificatePath("tls-certs/client.keystore")
    .SetClientCertificatePassword("IoTDB")
    .Build();

The ADO.NET connection string supports the same options:

DataSource=127.0.0.1;Port=6667;UseSsl=True;RootCertificatePath=tls-certs/ca.crt;ClientCertificatePath=tls-certs/client.keystore;ClientCertificatePassword=IoTDB

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

Code Formatting

This project uses dotnet format to enforce consistent code style based on the .editorconfig rules.

Check formatting locally

dotnet format --verify-no-changes

Auto-fix formatting issues

dotnet format

The CI pipeline will automatically check code formatting on all pull requests. Please ensure your code is properly formatted before submitting a PR.

Publish your own client on nuget.org

You can find out how to publish from this doc.