TDengine.Connector 3.1.6
TDengine C# Connector
English | 简体中文
Table of Contents
- 1. Introduction
- 2. Documentation
- 3. Prerequisites
- 4. Build
- 5. Testing
- 6. CI/CD
- 7. Submitting Issues
- 8. Submitting PRs
- 9. References
- 10. License
1. Introduction
TDengine.Connector
is the C# language connector provided by TDengine. C# developers can use it to develop C# application software that accesses TDengine cluster data.
2. Documentation
- To use C# connector, please check Developer Guide, which includes how an
application can introduce the
TDengine.Connector
, as well as examples of data writing, querying, schemaless writing, parameter binding, and data subscription. - For other reference information, please check Reference Manual, which includes version history, data types, example programs, API descriptions, and FAQs.
- This quick guide is mainly for developers who like to contribute/build/test the C# connector by themselves. To learn about TDengine, you can visit the official documentation.
3. Prerequisites
- Install .NET SDK 6.0
- Nuget Client
- TDengine has been deployed locally. For specific steps, please refer to Deploy TDengine. Please make sure taosd and taosAdapter have been started.
4. Build
dotnet restore
Restore the project's dependencies.dotnet build --no-restore
Build the project.
5. Testing
5.1 Test Execution
- Before running tests, ensure that the TDengine server is installed and that
taosd
andtaosAdapter
are running. The database should be empty. - In the project directory, run
dotnet test
to execute the tests. The tests will connect to the local TDengine server and taosAdapter for testing. - If the tests pass,
Test Run Successful
will be printed. If the tests fail, the failure informationTest Run Failed
will be printed.
5.2 Test Case Addition
Add test cases in the test
directory. Add ADO.NET test cases to test/Data.Tests
and client driver test cases to
test/Driver.Test/Client
.
The test cases use the xunit framework.
5.3 Performance Testing
Performance testing is in progress.
6. CI/CD
7. Submitting Issues
We welcome the submission of GitHub Issue. When submitting, please provide the following information:
- Description of the issue and whether it is consistently reproducible
- Driver version
- Connection parameters (excluding server address, username, and password)
- TDengine version
8. Submitting PRs
We welcome developers to contribute to this project. Please follow the steps below to submit a PR:
- Fork this project. Please refer to how to fork a repo.
- Create a new branch from the main branch with a meaningful branch name (
git checkout -b my_branch
). - Modify the code, ensure all unit tests pass, and add new unit tests to verify the changes.
- Push the changes to the remote branch (
git push origin my_branch
). - Create a Pull Request on GitHub. Please refer to how to create a pull request.
- After submitting the PR, you can find your PR through the Pull Request. Click on the corresponding link to see if the CI for your PR has passed. If it has passed, it will display "All checks have passed". Regardless of whether the CI passes or not, you can click "Show all checks" -> "Details" to view the detailed test case logs.
- After submitting the PR, if the CI passes, you can find your PR on the codecov page to check the coverage.
9. References
10. License
Showing the top 20 packages that depend on TDengine.Connector.
Packages | Downloads |
---|---|
TDengine.Ado.Data
TDengine ADO.NET驱动,使用用例看:https://github.com/DotNetNext/SqlSugar/blob/master/Src/Asp.NetCore2/TDengineTest/Program.cs
|
4 |
TDengine.Ado.Data
TDengine ADO.NET驱动
|
4 |
TDengine.Ado.Data
TDengine ADO.NET驱动,使用用例看:https://github.com/DotNetNext/SqlSugar/blob/master/Src/Asp.NetCore2/TDengineTest/Program.cs
|
3 |
TDengine.Ado.Data
TDengine ADO.NET驱动
|
3 |
TDengine.Ado.Data
TDengine ADO.NET驱动
|
2 |
TDengine.Ado.Data
TDengine ADO.NET驱动,使用用例看:https://github.com/DotNetNext/SqlSugar/blob/master/Src/Asp.NetCore2/TDengineTest/Program.cs
|
2 |
TDengine.Ado.Data
TDengine ADO.NET驱动,使用用例看:https://github.com/DotNetNext/SqlSugar/tree/master/Src/Asp.NetCore2/SqlSugar.TDengineCore
|
2 |
.NET Framework 4.5
- Newtonsoft.Json (>= 13.0.3)
.NET Framework 4.5.1
- Newtonsoft.Json (>= 13.0.3)
.NET 5.0
- Newtonsoft.Json (>= 13.0.3)
.NET 6.0
- Newtonsoft.Json (>= 13.0.3)
.NET Standard 2.0
- Newtonsoft.Json (>= 13.0.3)
.NET Standard 2.1
- Newtonsoft.Json (>= 13.0.3)
Version | Downloads | Last updated |
---|---|---|
3.1.6 | 1 | 2025/6/7 |
3.1.5 | 1 | 2025/6/8 |
3.1.4 | 1 | 2025/6/8 |
3.1.3 | 1 | 2025/6/8 |
3.1.2 | 1 | 2025/6/8 |
3.1.1 | 1 | 2025/6/8 |
3.1.0 | 1 | 2025/6/8 |
3.0.2 | 1 | 2025/6/8 |
3.0.1 | 1 | 2025/6/8 |
3.0.0 | 1 | 2025/6/8 |
1.0.8 | 1 | 2025/6/8 |
1.0.7 | 1 | 2025/6/8 |
1.0.6 | 1 | 2025/6/8 |
1.0.5 | 1 | 2025/6/8 |
1.0.4 | 1 | 2025/6/8 |
1.0.3 | 1 | 2025/6/8 |
1.0.2 | 1 | 2025/6/8 |
1.0.1 | 1 | 2025/6/8 |
1.0.0 | 1 | 2025/6/8 |