Go Connector for TDengine
English | 简体中文
[TDengine] provides Go database/sql
driver as [taosSql
][driver-go].
Remind
github.com/taosdata/driver-go/v2
Complete refactoring of the v1 version and separate the built-in database operation
interface database/sql/driver
to the directory taosSql
put other advanced functions such as subscription and stmt in
the directory af
Install
Go 1.14+ is highly recommended for newly created projects.
go mod init taos-demo
import taosSql:
import (
"database/sql"
_ "github.com/taosdata/driver-go/v2/taosSql"
)
Use go mod
for module management:
go mod tidy
Or go get
to directly install it:
go get github.com/taosdata/driver-go/v2/taosSql
Usage
database/sql
Standard
A simple use case:
package main
import (
"database/sql"
"fmt"
"time"
_ "github.com/taosdata/driver-go/v2/taosSql"
)
func main() {
var taosuri = "root:taosdata/tcp(localhost:6030)/"
taos, err := sql.Open("taosSql", taosuri)
if err != nil {
fmt.Println("failed to connect TDengine, err:", err)
return
}
defer taos.Close()
taos.Exec("create database if not exists test")
taos.Exec("use test")
taos.Exec("create table if not exists tb1 (ts timestamp, a int)")
_, err = taos.Exec("insert into tb1 values(now, 0)(now+1s,1)(now+2s,2)(now+3s,3)")
if err != nil {
fmt.Println("failed to insert, err:", err)
return
}
rows, err := taos.Query("select * from tb1")
if err != nil {
fmt.Println("failed to select from table, err:", err)
return
}
defer rows.Close()
for rows.Next() {
var r struct {
ts time.Time
a int
}
err := rows.Scan(&r.ts, &r.a)
if err != nil {
fmt.Println("scan error:\n", err)
return
}
fmt.Println(r.ts, r.a)
}
}
APIs that are worthy to have a check:
-
sql.Open(DRIVER_NAME string, dataSourceName string) *DB
This API will create a
database/sql
DB object, results with type*DB
.DRIVER_NAME
should be setted astaosSql
, anddataSourceName
should be a URI likeuser:password@/tcp(host:port)/dbname
. For HA use case, useuser:password@/cfg/dbname
to apply configs in/etc/taos/taos.cfg
。 -
func (db *DB) Exec(query string, args ...interface{}) (Result, error)
Execute non resultset SQLs, like
create
,alter
etc. -
func (db *DB) Query(query string, args ...interface{}) (*Rows, error)
Execute a query with resultset.
-
func (db *DB) Close() error
Close an DB object and disconnect.
Subscription
Open DB:
func Open(host, user, pass, db string, port int) (*Connector, error)
Subscribe:
func (conn *Connector) Subscribe(restart bool, topic string, sql string, interval time.Duration) (Subscriber, error)
Subscriber:
type Subscriber interface {
Consume() (driver.Rows, error)
Unsubscribe(keepProgress bool)
}
Check sample code for subscription
at examples/taoslogtail.go
。
Directory structure
driver-go
├── af //advanced function
├── common //common function and constants
├── errors // error type
├── examples //examples
├── go.mod
├── go.sum
├── README-CN.md
├── README.md
├── taosSql // database operation standard interface
├── types // inner type
└── wrapper // cgo wrapper
Link
driver-go: https://github.com/taosdata/driver-go
TDengine: https://github.com/taosdata/TDengine