TDengine Go Connector

GitHub Action Tests	CodeCov

English | 简体中文

Table of Contents

• 1. Introduction
  • 1.1 Connection Methods
  • 1.2 Supported Platforms
• 2. Get the Driver
• 3. Documentation
• 4. Prerequisites
• 5. Build
• 6. Testing
  • 6.1 Test Execution
  • 6.2 Test Case Addition
  • 6.3 Performance Testing
• 7. Submitting Issues
• 8. Submitting PRs
• 9. References
• 10. License

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.

1.1 Connection Methods

• Native Connection: Establishes a connection directly with the server program taosd through the client driver taosc. This method requires the client driver taosc and the server taosd to be of the same version.
• REST Connection: Establishes a connection with taosd through the REST API provided by the taosAdapter component. This method only supports executing SQL.
• WebSocket Connection: Establishes a connection with taosd through the WebSocket API provided by the taosAdapter component, without relying on the TDengine client driver.

We recommend using the WebSocket connection method. For detailed instructions, please refer to: Connection Methods.

1.2 Supported Platforms

• The platforms supported by the native connection are consistent with those supported by the TDengine client driver.
• WebSocket/REST connections support all platforms that can run Go.

2. Get the Driver

Import the Driver into the Project

import (
    "database/sql"
    _ "github.com/taosdata/driver-go/v3/taosSql"
)

To manage dependencies using go mod:

go mod tidy

Or, you can directly install the driver with go get:

go get github.com/taosdata/driver-go/v3/taosSql

3. Documentation

• For development examples, see Developer Guide, which includes examples of data writing, querying, schemaless writing, parameter binding, and data subscription.
• For other reference information, see Reference Manual, which includes version history, data types, example programs, API descriptions, and FAQs.

4. Prerequisites

• Go 1.14 or above and enable CGO with export CGO_ENABLED=1.
• TDengine has been deployed locally. For detailed steps, please refer to Deploy Server, and taosd and taosAdapter have been started.

5. Build

After writing an example program, use go build to build the program.

6. Testing

6.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 go test ./... to execute the tests. The tests will connect to the local TDengine server and taosAdapter for testing.
3. The output result PASS means the test passed, while FAIL means the test failed. For detailed information, run go test -v ./....

6.2 Test Case Addition

Add test cases to the *_test.go file to ensure that the test cases cover the new code.

6.3 Performance Testing

Performance testing is in progress.

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, 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