# TDengine Go Connector

**Repository Path**: pyddot/tdengine-go-connector

## Basic Information

- **Project Name**: TDengine Go Connector
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-07
- **Last Updated**: 2021-07-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


[![Build Status](https://cloud.drone.io/api/badges/taosdata/driver-go/status.svg)](https://cloud.drone.io/taosdata/driver-go)

# Go connector for TDengine

TDengine提供了GO驱动程序taosSql. taosSql实现了GO语言的内置接口database/sql/driver。用户只需按如下方式引入包就可以在应用程序中访问TDengin, 详见<https://github.com/taosdata/driver-go/blob/develop/taosSql/driver_test.go>

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

## 常用API

```go
sql.Open(DRIVER_NAME string, dataSourceName string) *DB
```

该API用来打开DB，返回一个类型为`\*DB`的对象，一般情况下，`DRIVER_NAME`设置为字符串`taosSql`, `dataSourceName`设置为字符串`user:password@/tcp(host:port)/dbname`，如果客户想要用多个goroutine并发访问TDengine, 那么需要在各个goroutine中分别创建一个`sql.Open`对象并用之访问TDengine。

建议使用 `user:password@/tcp(:)/dbname` 或 `user:password@/cfg/dbname` 使用 `/etc/taos/taos.cfg` 中的配置来支持客户端连接的高可用。

注意： 该API成功创建的时候，并没有做权限等检查，只有在真正执行Query或者Exec的时候才能真正的去创建连接，并同时检查user/password/host/port是不是合法。 另外，由于整个驱动程序大部分实现都下沉到taosSql所依赖的libtaos中。所以，sql.Open本身特别轻量。

```go
func (db *DB) Exec(query string, args ...interface{}) (Result, error)
```

`sql.Open`内置的方法，用来执行非查询相关SQL

```go
func (db *DB) Query(query string, args ...interface{}) (*Rows, error)
```

`sql.Open`内置的方法，用来执行查询语句

Please refer to the [demo app](https://github.com/taosdata/TDengine/blob/develop/tests/examples/go/taosdemo.go) for details.

## 订阅使用

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)
}
```

详情参见例子`examples/taoslogtail.go`。