doc: driver-go support stmt via WebSocket (#17740)
* doc: driver-go support stmt via WebSocket * docs: fix typos Co-authored-by: Shuduo Sang <sangshuduo@gmail.com>
This commit is contained in:
parent
eb02c0d314
commit
f2cee43cb7
|
@ -353,7 +353,7 @@ The `af` package encapsulates TDengine advanced functions such as connection man
|
|||
|
||||
Closes the connection.
|
||||
|
||||
#### Subscribe to
|
||||
#### Subscribe
|
||||
|
||||
* `func NewConsumer(conf *Config) (*Consumer, error)`
|
||||
|
||||
|
@ -387,7 +387,7 @@ Close consumer.
|
|||
|
||||
* `func (conn *Connector) InfluxDBInsertLines(lines []string, precision string) error`
|
||||
|
||||
Write to influxDB line protocol.
|
||||
Write to InfluxDB line protocol.
|
||||
|
||||
* `func (conn *Connector) OpenTSDBInsertTelnetLines(lines []string) error`
|
||||
|
||||
|
@ -413,7 +413,7 @@ Close consumer.
|
|||
|
||||
* `func (stmt *InsertStmt) SetTableName(name string) error`
|
||||
|
||||
Bind the set table name parameter.
|
||||
Bind the table name parameter.
|
||||
|
||||
* `func (stmt *InsertStmt) SetSubTableName(name string) error`
|
||||
|
||||
|
@ -463,6 +463,54 @@ Close consumer.
|
|||
|
||||
For a complete example see [GitHub sample file](https://github.com/taosdata/driver-go/blob/3.0/examples/tmqoverws/main.go)
|
||||
|
||||
### parameter binding via WebSocket
|
||||
|
||||
* `func NewConnector(config *Config) (*Connector, error)`
|
||||
|
||||
Create a connection.
|
||||
|
||||
* `func (c *Connector) Init() (*Stmt, error)`
|
||||
|
||||
Initialize the parameters.
|
||||
|
||||
* `func (c *Connector) Close() error`
|
||||
|
||||
Close the connection.
|
||||
|
||||
* `func (s *Stmt) Prepare(sql string) error`
|
||||
|
||||
Parameter binding preprocessing SQL statement.
|
||||
|
||||
* `func (s *Stmt) SetTableName(name string) error`
|
||||
|
||||
Bind the table name parameter.
|
||||
|
||||
* `func (s *Stmt) SetTags(tags *param.Param, bindType *param.ColumnType) error`
|
||||
|
||||
Set tags.
|
||||
|
||||
* `func (s *Stmt) BindParam(params []*param.Param, bindType *param.ColumnType) error`
|
||||
|
||||
Parameter bind multiple rows of data.
|
||||
|
||||
* `func (s *Stmt) AddBatch() error`
|
||||
|
||||
Add to a parameter-bound batch.
|
||||
|
||||
* `func (s *Stmt) Exec() error`
|
||||
|
||||
Execute a parameter binding.
|
||||
|
||||
* `func (s *Stmt) GetAffectedRows() int`
|
||||
|
||||
Gets the number of affected rows inserted by the parameter binding.
|
||||
|
||||
* `func (s *Stmt) Close() error`
|
||||
|
||||
Closes the parameter binding.
|
||||
|
||||
For a complete example see [GitHub sample file](https://github.com/taosdata/driver-go/blob/3.0/examples/stmtoverws/main.go)
|
||||
|
||||
## API Reference
|
||||
|
||||
Full API see [driver-go documentation](https://pkg.go.dev/github.com/taosdata/driver-go/v3)
|
||||
|
|
|
@ -8,7 +8,7 @@ title: TDengine Go Connector
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
import Preparition from "./_preparition.mdx"
|
||||
import Preparation from "./_preparation.mdx"
|
||||
import GoInsert from "../07-develop/03-insert-data/_go_sql.mdx"
|
||||
import GoInfluxLine from "../07-develop/03-insert-data/_go_line.mdx"
|
||||
import GoOpenTSDBTelnet from "../07-develop/03-insert-data/_go_opts_telnet.mdx"
|
||||
|
@ -389,7 +389,7 @@ func main() {
|
|||
|
||||
* `func (conn *Connector) InfluxDBInsertLines(lines []string, precision string) error`
|
||||
|
||||
写入 influxDB 行协议。
|
||||
写入 InfluxDB 行协议。
|
||||
|
||||
* `func (conn *Connector) OpenTSDBInsertTelnetLines(lines []string) error`
|
||||
|
||||
|
@ -465,6 +465,54 @@ func main() {
|
|||
|
||||
完整订阅示例参见 [GitHub 示例文件](https://github.com/taosdata/driver-go/blob/3.0/examples/tmqoverws/main.go)
|
||||
|
||||
### 通过 WebSocket 进行参数绑定
|
||||
|
||||
* `func NewConnector(config *Config) (*Connector, error)`
|
||||
|
||||
创建连接。
|
||||
|
||||
* `func (c *Connector) Init() (*Stmt, error)`
|
||||
|
||||
初始化参数。
|
||||
|
||||
* `func (c *Connector) Close() error`
|
||||
|
||||
关闭连接。
|
||||
|
||||
* `func (s *Stmt) Prepare(sql string) error`
|
||||
|
||||
参数绑定预处理 SQL 语句。
|
||||
|
||||
* `func (s *Stmt) SetTableName(name string) error`
|
||||
|
||||
参数绑定设置表名。
|
||||
|
||||
* `func (s *Stmt) SetTags(tags *param.Param, bindType *param.ColumnType) error`
|
||||
|
||||
参数绑定设置标签。
|
||||
|
||||
* `func (s *Stmt) BindParam(params []*param.Param, bindType *param.ColumnType) error`
|
||||
|
||||
参数绑定多行数据。
|
||||
|
||||
* `func (s *Stmt) AddBatch() error`
|
||||
|
||||
添加到参数绑定批处理。
|
||||
|
||||
* `func (s *Stmt) Exec() error`
|
||||
|
||||
执行参数绑定。
|
||||
|
||||
* `func (s *Stmt) GetAffectedRows() int`
|
||||
|
||||
获取参数绑定插入受影响行数。
|
||||
|
||||
* `func (s *Stmt) Close() error`
|
||||
|
||||
结束参数绑定。
|
||||
|
||||
完整参数绑定示例参见 [GitHub 示例文件](https://github.com/taosdata/driver-go/blob/3.0/examples/stmtoverws/main.go)
|
||||
|
||||
## API 参考
|
||||
|
||||
全部 API 见 [driver-go 文档](https://pkg.go.dev/github.com/taosdata/driver-go/v3)
|
||||
|
|
|
@ -7,7 +7,7 @@ title: TDengine Rust Connector
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
import Preparition from "./_preparition.mdx"
|
||||
import Preparation from "./_preparation.mdx"
|
||||
import RustInsert from "../07-develop/03-insert-data/_rust_sql.mdx"
|
||||
import RustBind from "../07-develop/03-insert-data/_rust_stmt.mdx"
|
||||
import RustQuery from "../07-develop/04-query-data/_rust.mdx"
|
||||
|
|
|
@ -7,7 +7,7 @@ title: TDengine Node.js Connector
|
|||
import Tabs from "@theme/Tabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
import Preparition from "./_preparition.mdx";
|
||||
import Preparation from "./_preparation.mdx";
|
||||
import NodeInsert from "../07-develop/03-insert-data/_js_sql.mdx";
|
||||
import NodeInfluxLine from "../07-develop/03-insert-data/_js_line.mdx";
|
||||
import NodeOpenTSDBTelnet from "../07-develop/03-insert-data/_js_opts_telnet.mdx";
|
||||
|
@ -249,4 +249,4 @@ Node.js 连接器的使用参见[视频教程](https://www.taosdata.com/blog/202
|
|||
|
||||
## API 参考
|
||||
|
||||
[API 参考](https://docs.taosdata.com/api/td2.0-connector/)
|
||||
[API 参考](https://docs.taosdata.com/api/td2.0-connector/)
|
||||
|
|
|
@ -7,7 +7,7 @@ title: C# Connector
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
import Preparition from "./_preparition.mdx"
|
||||
import Preparation from "./_preparation.mdx"
|
||||
import CSInsert from "../07-develop/03-insert-data/_cs_sql.mdx"
|
||||
import CSInfluxLine from "../07-develop/03-insert-data/_cs_line.mdx"
|
||||
import CSOpenTSDBTelnet from "../07-develop/03-insert-data/_cs_opts_telnet.mdx"
|
||||
|
|
Loading…
Reference in New Issue