Go Connector for TDengine
English | 简体中文
TDengine provides Go database/sql driver as taosSql.
Install
Go 1.14+ is highly recommended for newly created projects.
go mod init taos-demoimport taosSql：
import (
"database/sql"
_ "github.com/taosdata/driver-go/taosSql"
)Use go mod for module management:
go mod tidyOr go get to directly install it:
go get github.com/taosdata/driver-go/taosSqlUse win branch if you are using the module in Windows os, since STMT-series APIs are not fully supported currently.
go get github.com/taosdata/driver-go/taosSql@winUsage
database/sql Standard
A simple use case：
import (
"fmt"
"database/sql"
_ "github.com/taosdata/driver-go/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) *DBThis API will create a
database/sqlDB object, results with type*DB.DRIVER_NAMEshould be setted astaosSql, anddataSourceNameshould be an URI likeuser:password@/tcp(host:port)/dbname. For HA use case, useuser:password@/cfg/dbnameto apply configs in/etc/taos/taos.cfg。 -
func (db *DB) Exec(query string, args ...interface{}) (Result, error)Execute non resultset SQLs, like
create,alteretc. -
func (db *DB) Query(query string, args ...interface{}) (*Rows, error)Execute an query with resultset.
-
func (db *DB) Close() errorClose an DB object and disconnect.
Subscription
Open DB:
Open(dbname string) (db DB, err error)Subscribe:
type DB interface {
Subscribe(restart bool, name string, sql string, interval time.Duration) (Topic, error)
Close() error
}Topic:
type Topic interface {
Consume() (driver.Rows, error)
Unsubscribe(keepProgress bool)
}Check sample code for subscription at examples/taoslogtail.go。