English | 简体中文

Table of Contents

• 1. Introduction
• 2. Documentation
• 3. Prerequisites
• 4. Build
• 5. Testing
  • 5.1 Test Execution
  • 5.2 Test Case Addition
  • 5.3 Performance 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

In the project directory, run dotnet restore to restore the project's dependencies, and then run dotnet build --no-restore to build the project.

5. Testing

5.1 Test Execution

1. Before running tests, ensure that the TDengine server is installed and that taosd and taosAdapter are running. The database should be empty.
2. In the project directory, run dotnet test to execute the tests. The tests will connect to the local TDengine server and taosAdapter for testing.
3. If the tests pass, Test Run Successful will be printed. If the tests fail, the failure information Test 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

• Build Workflow
• Code Coverage

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:

1. Fork this project. Please refer to how to fork a repo.
2. Create a new branch from the main branch with a meaningful branch name (git checkout -b my_branch).
3. Modify the code, ensure all unit tests pass, and add new unit tests to verify the changes.
4. Push the changes to the remote branch (git push origin my_branch).
5. Create a Pull Request on GitHub. Please refer to how to create a pull request.
6. 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.
7. After submitting the PR, if the CI passes, you can find your PR on the codecov page to check the coverage.

9. References

• TDengine Official Website
• TDengine GitHub

10. License

MIT License