TDengine Go Connector

English | 简体中文
Table of Contents
1. Introduction
driver-go
is the official Go language connector for TDengine. It implements the Go language database/sql
interface,
allowing Go developers to create applications that interact with TDengine clusters.
2. Documentation
- To use Go connector, please check Developer Guide, which includes how an
application can introduce the
driver-go
, 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 Go connector by themselves. To learn
about TDengine, you can visit the official documentation.
3. Prerequisites
- Go 1.14 or above and enable CGO with
export CGO_ENABLED=1
.
- TDengine has been deployed locally. For specific steps, please refer
to Deploy TDengine. Please make sure taosd and
taosAdapter have been started.
4. Build
No need to build.
5. Testing
5.1 Test Execution
- Before running tests, ensure that the TDengine server is installed and that
taosd
and taosAdapter
are running.
The database should be empty.
- In the project directory, run
go test ./...
to execute the tests. The tests will connect to the local TDengine
server and taosAdapter for testing.
- The output result
PASS
means the test passed, while FAIL
means the test failed. For detailed information, run
go test -v ./...
.
5.2 Test Case Addition
Add test cases to the *_test.go
file to ensure that the test cases cover the new code.
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. When submitting PRs, please follow these steps:
- 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
MIT License