improve doc
This commit is contained in:
sheyanjie-qq
parent
21c6243393
commit
a261908fec
|
|
@ -266,8 +266,8 @@ void basic_consume_loop(tmq_t* tmq) {
|
|||
// free the message
|
||||
taos_free_result(tmqmsg);
|
||||
}
|
||||
if (msgCnt > 10) {
|
||||
// consume 10 messages and break
|
||||
if (msgCnt > 50) {
|
||||
// consume 50 messages and break
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
|
@ -332,8 +332,8 @@ void manual_commit(tmq_t* tmq) {
|
|||
// free the message
|
||||
taos_free_result(tmqmsg);
|
||||
}
|
||||
if (msgCnt > 10) {
|
||||
// consume 10 messages and break
|
||||
if (msgCnt > 50) {
|
||||
// consume 50 messages and break
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -11,8 +11,7 @@ use taos::taos_query;
|
|||
async fn main() -> anyhow::Result<()> {
|
||||
std::env::set_var("RUST_LOG", "taos=debug");
|
||||
pretty_env_logger::init();
|
||||
let dsn =
|
||||
std::env::var("TDENGINE_ClOUD_DSN").unwrap_or("taos://localhost:6030".to_string());
|
||||
let dsn = "taos://localhost:6030".to_string();
|
||||
log::debug!("dsn: {:?}", &dsn);
|
||||
|
||||
let client = TaosBuilder::from_dsn(dsn)?.build().await?;
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
```c title="原生连接"
|
||||
```c
|
||||
{{#include docs/examples/c/connect_example.c}}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -608,7 +608,7 @@ JDBC 驱动支持创建连接，返回支持 JDBC 标准的 `Connection` 接口
|
|||
- **接口说明**：以指定的协议类型、时间戳类型、TTL（生存时间）和请求 ID 写入多行数据。
|
||||
- **参数说明**：
|
||||
- `lines`：待写入的数据行数组。
|
||||
- `protocolType`：协议类型：支持 LINE， TELNET， JSON 三种。
|
||||
- `protocolType`：协议类型：支持 InfluxDB `LINE`，OpenTSDB `TELNET`，OpenTSDB `JSON` 三种。
|
||||
- `timestampType`：时间戳类型，支持 HOURS，MINUTES，SECONDS，MILLI_SECONDS，MICRO_SECONDS 和 NANO_SECONDS。
|
||||
- `ttl`：数据的生存时间，单位天。
|
||||
- `reqId`：请求 ID。
|
||||
|
|
@ -617,28 +617,28 @@ JDBC 驱动支持创建连接，返回支持 JDBC 标准的 `Connection` 接口
|
|||
- **接口说明**：以指定的协议类型和时间戳类型写入多行数据。
|
||||
- **参数说明**：
|
||||
- `lines`：待写入的数据行数组。
|
||||
- `protocolType`：协议类型：支持 LINE， TELNET， JSON 三种。
|
||||
- `protocolType`：协议类型：支持 InfluxDB `LINE`，OpenTSDB `TELNET`，OpenTSDB `JSON` 三种。
|
||||
- `timestampType`：时间戳类型，支持 HOURS，MINUTES，SECONDS，MILLI_SECONDS，MICRO_SECONDS 和 NANO_SECONDS。
|
||||
- **异常**：操作失败抛出 SQLException 异常。
|
||||
- `void write(String line, SchemalessProtocolType protocolType, SchemalessTimestampType timestampType) throws SQLException`
|
||||
- **接口说明**：以指定的协议类型和时间戳类型写入单行数据。
|
||||
- **参数说明**：
|
||||
- `line`：待写入的数据行。
|
||||
- `protocolType`：协议类型：支持 LINE， TELNET， JSON 三种。
|
||||
- `protocolType`：协议类型：支持 InfluxDB `LINE`，OpenTSDB `TELNET`，OpenTSDB `JSON` 三种。
|
||||
- `timestampType`：时间戳类型，支持 HOURS，MINUTES，SECONDS，MILLI_SECONDS，MICRO_SECONDS 和 NANO_SECONDS。
|
||||
- **异常**：操作失败抛出 SQLException 异常。
|
||||
- `void write(List<String> lines, SchemalessProtocolType protocolType, SchemalessTimestampType timestampType) throws SQLException`
|
||||
- **接口说明**：以指定的协议类型和时间戳类型写入多行数据（使用列表）。
|
||||
- **参数说明**：
|
||||
- `lines`：待写入的数据行列表。
|
||||
- `protocolType`：协议类型：支持 LINE， TELNET， JSON 三种。
|
||||
- `protocolType`：协议类型：支持 InfluxDB `LINE`，OpenTSDB `TELNET`，OpenTSDB `JSON` 三种。
|
||||
- `timestampType`：时间戳类型，支持 HOURS，MINUTES，SECONDS，MILLI_SECONDS，MICRO_SECONDS 和 NANO_SECONDS。
|
||||
- **异常**：操作失败抛出 SQLException 异常。
|
||||
- `int writeRaw(String line, SchemalessProtocolType protocolType, SchemalessTimestampType timestampType) throws SQLException`
|
||||
- **接口说明**：以指定的协议类型和时间戳类型写入多行回车符分割的原始数据，回车符分割，并返回操作结果。
|
||||
- **参数说明**：
|
||||
- `line`：待写入的原始数据。
|
||||
- `protocolType`：协议类型：支持 LINE， TELNET， JSON 三种。
|
||||
- `protocolType`：协议类型：支持 InfluxDB `LINE`，OpenTSDB `TELNET`，OpenTSDB `JSON` 三种。
|
||||
- `timestampType`：时间戳类型，支持 HOURS，MINUTES，SECONDS，MILLI_SECONDS，MICRO_SECONDS 和 NANO_SECONDS。
|
||||
- **返回值**：操作结果。
|
||||
- **异常**：操作失败抛出 SQLException 异常。
|
||||
|
|
@ -646,7 +646,7 @@ JDBC 驱动支持创建连接，返回支持 JDBC 标准的 `Connection` 接口
|
|||
- **接口说明**：以指定的协议类型、时间戳类型、TTL（生存时间）和请求 ID 写入多行回车符分割的原始数据，并返回操作结果。
|
||||
- **参数说明**：
|
||||
- `line`：待写入的原始数据。
|
||||
- `protocolType`：协议类型：支持 LINE， TELNET， JSON 三种。
|
||||
- `protocolType`：协议类型：支持 InfluxDB `LINE`，OpenTSDB `TELNET`，OpenTSDB `JSON` 三种。
|
||||
- `timestampType`：时间戳类型，支持 HOURS，MINUTES，SECONDS，MILLI_SECONDS，MICRO_SECONDS 和 NANO_SECONDS。
|
||||
- `ttl`：数据的生存时间，单位天。
|
||||
- `reqId`：请求 ID。
|
||||
|
|
|
|||
|
|
@ -243,7 +243,7 @@ SmlData 结构体提供了无模式写入的数据结构，以及获取属性的
|
|||
- `pub struct SmlData`
|
||||
- **结构体说明**：`SmlData` 结构体用于存储无模式数据及其相关信息。
|
||||
- **字段说明**：
|
||||
- `protocol`：无模式协议，支持 `Line`, `Telnet`, `Json`, 三种。
|
||||
- `protocol`：无模式协议，支持 InfluxDB `Line`, OpenTSDB `Telnet`, OpenTSDB `Json`, 三种。
|
||||
- `precision`：时间戳精度，支持 `Hours`, `Minutes`, `Seconds`, `Millisecond`（默认）, `Microsecond`, `Nanosecond`。
|
||||
- `data`：数据列表。
|
||||
- `ttl`：数据存活时间，单位为秒。
|
||||
|
|
@ -251,7 +251,7 @@ SmlData 结构体提供了无模式写入的数据结构，以及获取属性的
|
|||
|
||||
- `pub fn protocol(&self) -> SchemalessProtocol`
|
||||
- **接口说明**：获取无模式协议。
|
||||
- **返回值**：无模式协议类型，支持 `Line`, `Telnet`, `Json`, 三种。
|
||||
- **返回值**：无模式协议类型，支持 InfluxDB `Line`, OpenTSDB `Telnet`, OpenTSDB `Json`, 三种。
|
||||
|
||||
- `pub fn precision(&self) -> SchemalessPrecision`
|
||||
- **接口说明**：获取时间戳精度。
|
||||
|
|
|
|||
|
|
@ -352,36 +352,36 @@ WSConfig 中的配置如下：
|
|||
- `partitions`：一个 `Array<TopicPartition>` 类型的参数，表示要查询的分区集合。
|
||||
- `reqId`: 请求 id 非必填，用于问题追踪。
|
||||
- **返回值**：`Array<TopicPartition>`，即一组分区最后提交的偏移量。
|
||||
- **异常**：如果在获取提交的偏移量过程中发生错误，将抛出 TDWebSocketClientError 异常。
|
||||
- **异常**：如果在获取提交的偏移量过程中发生错误，将抛出 `TDWebSocketClientError` 异常。
|
||||
- `async seek(partition:TopicPartition, reqId?:number):Promise<void>`
|
||||
- **接口说明**：将给定分区的偏移量设置到指定的位置。
|
||||
- **参数说明**：
|
||||
- `partition`：一个 `TopicPartition` 类型的参数，表示要操作的分区和要设置的偏移量。
|
||||
- `reqId`: 请求 id 非必填，用于问题追踪。
|
||||
- **异常**：如果在设置偏移量过程中发生错误，将抛出 TDWebSocketClientError 异常。
|
||||
- **异常**：如果在设置偏移量过程中发生错误，将抛出 `TDWebSocketClientError` 异常。
|
||||
- `async positions(partitions:Array<TopicPartition>, reqId?:number):Promise<Array<TopicPartition>>`
|
||||
- **接口说明**：获取给定分区当前的偏移量。
|
||||
- **参数说明**：
|
||||
- `partitions`：一个 `TopicPartition` 类型的参数，表示要查询的分区。
|
||||
- `reqId`: 请求 id 非必填，用于问题追踪。
|
||||
- **返回值**：`Array<TopicPartition>`，即一组分区最后提交的偏移量。
|
||||
- **异常**：如果在获取偏移量过程中发生错误，将抛出 TDWebSocketClientError 异常。
|
||||
- **异常**：如果在获取偏移量过程中发生错误，将抛出 `TDWebSocketClientError` 异常。
|
||||
- `async seekToBeginning(partitions:Array<TopicPartition>):Promise<void>`
|
||||
- **接口说明**：将一组分区的偏移量设置到最早的偏移量。
|
||||
- **参数说明**：
|
||||
- `partitions`：一个 `Array<TopicPartition>` 类型的参数，表示要操作的分区集合。
|
||||
- **异常**：如果在设置偏移量过程中发生错误，将抛出 TDWebSocketClientError 异常。
|
||||
- **异常**：如果在设置偏移量过程中发生错误，将抛出 `TDWebSocketClientError` 异常。
|
||||
- `async seekToEnd(partitions:Array<TopicPartition>):Promise<void>`
|
||||
- **接口说明**：将一组分区的偏移量设置到最新的偏移量。
|
||||
- **参数说明**：
|
||||
- `partitions`：一个 `Array<TopicPartition>` 类型的参数，表示要操作的分区集合。
|
||||
- **异常**：如果在设置偏移量过程中发生错误，将抛出 TDWebSocketClientError 异常。
|
||||
- **异常**：如果在设置偏移量过程中发生错误，将抛出 `TDWebSocketClientError` 异常。
|
||||
- `async assignment(topics?:string[]):Promise<Array<TopicPartition>>`
|
||||
- **接口说明**：获取消费者当前分配的指定的分区或所有分区。
|
||||
- **参数说明**：
|
||||
- `topics`：需要获取的分区（非必填），不填表示获取全部的分区
|
||||
- **返回值**：返回值类型为 `Array<TopicPartition>`，即消费者当前分配的所有分区。
|
||||
- **异常**：如果在获取分配的分区过程中发生错误，将抛出 TDWebSocketClientError 异常。
|
||||
- **异常**：如果在获取分配的分区过程中发生错误，将抛出 `TDWebSocketClientError` 异常。
|
||||
- `async close():Promise<void>`
|
||||
- **接口说明**：关闭 tmq 连接。
|
||||
- **异常**：操作失败抛出 `TDWebSocketClientError` 异常。
|
||||
|
|
|
|||
Loading…
Reference in New Issue