C/C++ Connector

C/C++ 开发人员可以使用 TDengine 的客户端驱动,即 C/C++连接器 (以下都用 TDengine 客户端驱动表示),开发自己的应用来连接 TDengine 集群完成数据存储、查询以及其他功能。TDengine 客户端驱动的 API 类似于 MySQL 的 C API。应用程序使用时,需要包含 TDengine 头文件 taos.h,里面列出了提供的 API 的函数原型;应用程序还要链接到所在平台上对应的动态库。

  1. #include <taos.h>

TDengine 服务端或客户端安装后,taos.h 位于:

  • Linux:/usr/local/taos/include
  • Windows:C:\TDengine\include
  • macOS:/usr/local/include

TDengine 客户端驱动的动态库位于:

  • Linux: /usr/local/taos/driver/libtaos.so
  • Windows: C:\TDengine\taos.dll
  • macOS: /usr/local/lib/libtaos.dylib

支持的平台

请参考支持的平台列表

支持的版本

TDengine 客户端驱动的版本号与 TDengine 服务端的版本号是一一对应的强对应关系,建议使用与 TDengine 服务端完全相同的客户端驱动。虽然低版本的客户端驱动在前三段版本号一致(即仅第四段版本号不同)的情况下也能够与高版本的服务端相兼容,但这并非推荐用法。强烈不建议使用高版本的客户端驱动访问低版本的服务端。

安装步骤

TDengine 客户端驱动的安装请参考 安装指南

建立连接

使用客户端驱动访问 TDengine 集群的基本过程为:建立连接、查询和写入、关闭连接、清除资源。

下面为建立连接的示例代码,其中省略了查询和写入部分,展示了如何建立连接、关闭连接以及清除资源。

  1. TAOS *taos = taos_connect("localhost:6030", "root", "taosdata", NULL, 0);
  2. if (taos == NULL) {
  3. printf("failed to connect to server, reason:%s\n", "null taos" /*taos_errstr(taos)*/);
  4. exit(1);
  5. }
  6. /* put your code here for read and write */
  7. taos_close(taos);
  8. taos_cleanup();

在上面的示例代码中, taos_connect() 建立到客户端程序所在主机的 6030 端口的连接,taos_close()关闭当前连接,taos_cleanup()清除客户端驱动所申请和使用的资源。

C/C++ - 图1note
  • 如未特别说明,当 API 的返回值是整数时,0 代表成功,其它是代表失败原因的错误码,当返回值是指针时, NULL 表示失败。
  • 所有的错误码以及对应的原因描述在 taoserror.h 文件中。

示例程序

本节展示了使用客户端驱动访问 TDengine 集群的常见访问方式的示例代码。

同步查询示例

同步查询

  1. /*
  2. * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
  3. *
  4. * This program is free software: you can use, redistribute, and/or modify
  5. * it under the terms of the GNU Affero General Public License, version 3
  6. * or later ("AGPL"), as published by the Free Software Foundation.
  7. *
  8. * This program is distributed in the hope that it will be useful, but WITHOUT
  9. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10. * FITNESS FOR A PARTICULAR PURPOSE.
  11. *
  12. * You should have received a copy of the GNU Affero General Public License
  13. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. */
  15. // TAOS standard API example. The same syntax as MySQL, but only a subset
  16. // to compile: gcc -o demo demo.c -ltaos
  17. #include <inttypes.h>
  18. #include <stdio.h>
  19. #include <stdlib.h>
  20. #include <string.h>
  21. #include "taos.h" // TAOS header file
  22. static void queryDB(TAOS *taos, char *command) {
  23. int i;
  24. TAOS_RES *pSql = NULL;
  25. int32_t code = -1;
  26. for (i = 0; i < 5; i++) {
  27. if (NULL != pSql) {
  28. taos_free_result(pSql);
  29. pSql = NULL;
  30. }
  31. pSql = taos_query(taos, command);
  32. code = taos_errno(pSql);
  33. if (0 == code) {
  34. break;
  35. }
  36. }
  37. if (code != 0) {
  38. fprintf(stderr, "Failed to run %s, reason: %s\n", command, taos_errstr(pSql));
  39. taos_free_result(pSql);
  40. taos_close(taos);
  41. exit(EXIT_FAILURE);
  42. }
  43. taos_free_result(pSql);
  44. }
  45. void Test(TAOS *taos, char *qstr, int i);
  46. int main(int argc, char *argv[]) {
  47. char qstr[1024];
  48. // connect to server
  49. if (argc < 2) {
  50. printf("please input server-ip \n");
  51. return 0;
  52. }
  53. TAOS *taos = taos_connect(argv[1], "root", "taosdata", NULL, 0);
  54. if (taos == NULL) {
  55. printf("failed to connect to server, reason:%s\n", "null taos"/*taos_errstr(taos)*/);
  56. exit(1);
  57. }
  58. for (int i = 0; i < 100; i++) {
  59. Test(taos, qstr, i);
  60. }
  61. taos_close(taos);
  62. taos_cleanup();
  63. }
  64. void Test(TAOS *taos, char *qstr, int index) {
  65. printf("==================test at %d\n================================", index);
  66. queryDB(taos, "drop database if exists demo");
  67. queryDB(taos, "create database demo");
  68. TAOS_RES *result;
  69. queryDB(taos, "use demo");
  70. queryDB(taos, "create table m1 (ts timestamp, ti tinyint, si smallint, i int, bi bigint, f float, d double, b binary(10))");
  71. printf("success to create table\n");
  72. int i = 0;
  73. for (i = 0; i < 10; ++i) {
  74. sprintf(qstr, "insert into m1 values (%" PRId64 ", %d, %d, %d, %d, %f, %lf, '%s')", (uint64_t)(1546300800000 + i * 1000), i, i, i, i*10000000, i*1.0, i*2.0, "hello");
  75. printf("qstr: %s\n", qstr);
  76. // note: how do you wanna do if taos_query returns non-NULL
  77. // if (taos_query(taos, qstr)) {
  78. // printf("insert row: %i, reason:%s\n", i, taos_errstr(taos));
  79. // }
  80. TAOS_RES *result1 = taos_query(taos, qstr);
  81. if (result1 == NULL || taos_errno(result1) != 0) {
  82. printf("failed to insert row, reason:%s\n", taos_errstr(result1));
  83. taos_free_result(result1);
  84. exit(1);
  85. } else {
  86. printf("insert row: %i\n", i);
  87. }
  88. taos_free_result(result1);
  89. }
  90. printf("success to insert rows, total %d rows\n", i);
  91. // query the records
  92. sprintf(qstr, "SELECT * FROM m1");
  93. result = taos_query(taos, qstr);
  94. if (result == NULL || taos_errno(result) != 0) {
  95. printf("failed to select, reason:%s\n", taos_errstr(result));
  96. taos_free_result(result);
  97. exit(1);
  98. }
  99. TAOS_ROW row;
  100. int rows = 0;
  101. int num_fields = taos_field_count(result);
  102. TAOS_FIELD *fields = taos_fetch_fields(result);
  103. printf("num_fields = %d\n", num_fields);
  104. printf("select * from table, result:\n");
  105. // fetch the records row by row
  106. while ((row = taos_fetch_row(result))) {
  107. char temp[1024] = {0};
  108. rows++;
  109. taos_print_row(temp, row, fields, num_fields);
  110. printf("%s\n", temp);
  111. }
  112. taos_free_result(result);
  113. printf("====demo end====\n\n");
  114. }

查看源码 格式化输出不同类型字段函数 taos_print_row

  1. int taos_print_row(char *str, TAOS_ROW row, TAOS_FIELD *fields, int num_fields) {
  2. int32_t len = 0;
  3. for (int i = 0; i < num_fields; ++i) {
  4. if (i > 0) {
  5. str[len++] = ' ';
  6. }
  7. if (row[i] == NULL) {
  8. len += sprintf(str + len, "%s", TSDB_DATA_NULL_STR);
  9. continue;
  10. }
  11. switch (fields[i].type) {
  12. case TSDB_DATA_TYPE_TINYINT:
  13. len += sprintf(str + len, "%d", *((int8_t *)row[i]));
  14. break;
  15. case TSDB_DATA_TYPE_UTINYINT:
  16. len += sprintf(str + len, "%u", *((uint8_t *)row[i]));
  17. break;
  18. case TSDB_DATA_TYPE_SMALLINT:
  19. len += sprintf(str + len, "%d", *((int16_t *)row[i]));
  20. break;
  21. case TSDB_DATA_TYPE_USMALLINT:
  22. len += sprintf(str + len, "%u", *((uint16_t *)row[i]));
  23. break;
  24. case TSDB_DATA_TYPE_INT:
  25. len += sprintf(str + len, "%d", *((int32_t *)row[i]));
  26. break;
  27. case TSDB_DATA_TYPE_UINT:
  28. len += sprintf(str + len, "%u", *((uint32_t *)row[i]));
  29. break;
  30. case TSDB_DATA_TYPE_BIGINT:
  31. len += sprintf(str + len, "%" PRId64, *((int64_t *)row[i]));
  32. break;
  33. case TSDB_DATA_TYPE_UBIGINT:
  34. len += sprintf(str + len, "%" PRIu64, *((uint64_t *)row[i]));
  35. break;
  36. case TSDB_DATA_TYPE_FLOAT: {
  37. float fv = 0;
  38. fv = GET_FLOAT_VAL(row[i]);
  39. len += sprintf(str + len, "%f", fv);
  40. } break;
  41. case TSDB_DATA_TYPE_DOUBLE: {
  42. double dv = 0;
  43. dv = GET_DOUBLE_VAL(row[i]);
  44. len += sprintf(str + len, "%lf", dv);
  45. } break;
  46. case TSDB_DATA_TYPE_BINARY:
  47. case TSDB_DATA_TYPE_NCHAR: {
  48. int32_t charLen = varDataLen((char *)row[i] - VARSTR_HEADER_SIZE);
  49. if (fields[i].type == TSDB_DATA_TYPE_BINARY) {
  50. assert(charLen <= fields[i].bytes && charLen >= 0);
  51. } else {
  52. assert(charLen <= fields[i].bytes * TSDB_NCHAR_SIZE && charLen >= 0);
  53. }
  54. memcpy(str + len, row[i], charLen);
  55. len += charLen;
  56. } break;
  57. case TSDB_DATA_TYPE_TIMESTAMP:
  58. len += sprintf(str + len, "%" PRId64, *((int64_t *)row[i]));
  59. break;
  60. case TSDB_DATA_TYPE_BOOL:
  61. len += sprintf(str + len, "%d", *((int8_t *)row[i]));
  62. default:
  63. break;
  64. }
  65. }
  66. str[len] = 0;
  67. return len;
  68. }

异步查询示例

异步查询

  1. /*
  2. * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
  3. *
  4. * This program is free software: you can use, redistribute, and/or modify
  5. * it under the terms of the GNU Affero General Public License, version 3
  6. * or later ("AGPL"), as published by the Free Software Foundation.
  7. *
  8. * This program is distributed in the hope that it will be useful, but WITHOUT
  9. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10. * FITNESS FOR A PARTICULAR PURPOSE.
  11. *
  12. * You should have received a copy of the GNU Affero General Public License
  13. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. */
  15. // TAOS asynchronous API example
  16. // this example opens multiple tables, insert/retrieve multiple tables
  17. // it is used by TAOS internally for one performance testing
  18. // to compiple: gcc -o asyncdemo asyncdemo.c -ltaos
  19. #include <stdio.h>
  20. #include <stdlib.h>
  21. #include <sys/time.h>
  22. #include <unistd.h>
  23. #include <string.h>
  24. #include <inttypes.h>
  25. #include "taos.h"
  26. int points = 5;
  27. int numOfTables = 3;
  28. int tablesInsertProcessed = 0;
  29. int tablesSelectProcessed = 0;
  30. int64_t st, et;
  31. typedef struct {
  32. int id;
  33. TAOS *taos;
  34. char name[32];
  35. time_t timeStamp;
  36. int value;
  37. int rowsInserted;
  38. int rowsTried;
  39. int rowsRetrieved;
  40. } STable;
  41. void taos_insert_call_back(void *param, TAOS_RES *tres, int code);
  42. void taos_select_call_back(void *param, TAOS_RES *tres, int code);
  43. void shellPrintError(TAOS *taos);
  44. static void queryDB(TAOS *taos, char *command) {
  45. int i;
  46. TAOS_RES *pSql = NULL;
  47. int32_t code = -1;
  48. for (i = 0; i < 5; i++) {
  49. if (NULL != pSql) {
  50. taos_free_result(pSql);
  51. pSql = NULL;
  52. }
  53. pSql = taos_query(taos, command);
  54. code = taos_errno(pSql);
  55. if (0 == code) {
  56. break;
  57. }
  58. }
  59. if (code != 0) {
  60. fprintf(stderr, "Failed to run %s, reason: %s\n", command, taos_errstr(pSql));
  61. taos_free_result(pSql);
  62. taos_close(taos);
  63. taos_cleanup();
  64. exit(EXIT_FAILURE);
  65. }
  66. taos_free_result(pSql);
  67. }
  68. int main(int argc, char *argv[])
  69. {
  70. TAOS *taos;
  71. struct timeval systemTime;
  72. int i;
  73. char sql[1024] = { 0 };
  74. char prefix[20] = { 0 };
  75. char db[128] = { 0 };
  76. STable *tableList;
  77. if (argc != 5) {
  78. printf("usage: %s server-ip dbname rowsPerTable numOfTables\n", argv[0]);
  79. exit(0);
  80. }
  81. // a simple way to parse input parameters
  82. if (argc >= 3) strncpy(db, argv[2], sizeof(db) - 1);
  83. if (argc >= 4) points = atoi(argv[3]);
  84. if (argc >= 5) numOfTables = atoi(argv[4]);
  85. size_t size = sizeof(STable) * (size_t)numOfTables;
  86. tableList = (STable *)malloc(size);
  87. memset(tableList, 0, size);
  88. taos = taos_connect(argv[1], "root", "taosdata", NULL, 0);
  89. if (taos == NULL)
  90. shellPrintError(taos);
  91. printf("success to connect to server\n");
  92. sprintf(sql, "drop database if exists %s", db);
  93. queryDB(taos, sql);
  94. sprintf(sql, "create database %s", db);
  95. queryDB(taos, sql);
  96. sprintf(sql, "use %s", db);
  97. queryDB(taos, sql);
  98. strcpy(prefix, "asytbl_");
  99. for (i = 0; i < numOfTables; ++i) {
  100. tableList[i].id = i;
  101. tableList[i].taos = taos;
  102. sprintf(tableList[i].name, "%s%d", prefix, i);
  103. sprintf(sql, "create table %s%d (ts timestamp, volume bigint)", prefix, i);
  104. queryDB(taos, sql);
  105. }
  106. gettimeofday(&systemTime, NULL);
  107. for (i = 0; i < numOfTables; ++i)
  108. tableList[i].timeStamp = (time_t)(systemTime.tv_sec) * 1000 + systemTime.tv_usec / 1000;
  109. printf("success to create tables, press any key to insert\n");
  110. getchar();
  111. printf("start to insert...\n");
  112. gettimeofday(&systemTime, NULL);
  113. st = systemTime.tv_sec * 1000000 + systemTime.tv_usec;
  114. tablesInsertProcessed = 0;
  115. tablesSelectProcessed = 0;
  116. for (i = 0; i<numOfTables; ++i) {
  117. // insert records in asynchronous API
  118. sprintf(sql, "insert into %s values(%ld, 0)", tableList[i].name, 1546300800000 + i);
  119. taos_query_a(taos, sql, taos_insert_call_back, (void *)(tableList + i));
  120. }
  121. printf("once insert finished, presse any key to query\n");
  122. getchar();
  123. while(1) {
  124. if (tablesInsertProcessed < numOfTables) {
  125. printf("wait for process finished\n");
  126. sleep(1);
  127. continue;
  128. }
  129. break;
  130. }
  131. printf("start to query...\n");
  132. gettimeofday(&systemTime, NULL);
  133. st = systemTime.tv_sec * 1000000 + systemTime.tv_usec;
  134. for (i = 0; i < numOfTables; ++i) {
  135. // select records in asynchronous API
  136. sprintf(sql, "select * from %s", tableList[i].name);
  137. taos_query_a(taos, sql, taos_select_call_back, (void *)(tableList + i));
  138. }
  139. printf("\nonce finished, press any key to exit\n");
  140. getchar();
  141. while(1) {
  142. if (tablesSelectProcessed < numOfTables) {
  143. printf("wait for process finished\n");
  144. sleep(1);
  145. continue;
  146. }
  147. break;
  148. }
  149. for (i = 0; i<numOfTables; ++i) {
  150. printf("%s inserted:%d retrieved:%d\n", tableList[i].name, tableList[i].rowsInserted, tableList[i].rowsRetrieved);
  151. }
  152. taos_close(taos);
  153. free(tableList);
  154. printf("==== async demo end====\n");
  155. printf("\n");
  156. return 0;
  157. }
  158. void shellPrintError(TAOS *con)
  159. {
  160. fprintf(stderr, "TDengine error: %s\n", taos_errstr(con));
  161. taos_close(con);
  162. taos_cleanup();
  163. exit(1);
  164. }
  165. void taos_insert_call_back(void *param, TAOS_RES *tres, int code)
  166. {
  167. STable *pTable = (STable *)param;
  168. struct timeval systemTime;
  169. char sql[128];
  170. pTable->rowsTried++;
  171. if (code < 0) {
  172. printf("%s insert failed, code:%d, rows:%d\n", pTable->name, code, pTable->rowsTried);
  173. }
  174. else if (code == 0) {
  175. printf("%s not inserted\n", pTable->name);
  176. }
  177. else {
  178. pTable->rowsInserted++;
  179. }
  180. if (pTable->rowsTried < points) {
  181. // for this demo, insert another record
  182. sprintf(sql, "insert into %s values(%ld, %d)", pTable->name, 1546300800000+pTable->rowsTried*1000, pTable->rowsTried);
  183. taos_query_a(pTable->taos, sql, taos_insert_call_back, (void *)pTable);
  184. }
  185. else {
  186. printf("%d rows data are inserted into %s\n", points, pTable->name);
  187. tablesInsertProcessed++;
  188. if (tablesInsertProcessed >= numOfTables) {
  189. gettimeofday(&systemTime, NULL);
  190. et = systemTime.tv_sec * 1000000 + systemTime.tv_usec;
  191. printf("%" PRId64 " mseconds to insert %d data points\n", (et - st) / 1000, points*numOfTables);
  192. }
  193. }
  194. taos_free_result(tres);
  195. }
  196. void taos_retrieve_call_back(void *param, TAOS_RES *tres, int numOfRows)
  197. {
  198. STable *pTable = (STable *)param;
  199. struct timeval systemTime;
  200. if (numOfRows > 0) {
  201. for (int i = 0; i<numOfRows; ++i) {
  202. // synchronous API to retrieve a row from batch of records
  203. /*TAOS_ROW row = */(void)taos_fetch_row(tres);
  204. // process row
  205. }
  206. pTable->rowsRetrieved += numOfRows;
  207. // retrieve next batch of rows
  208. taos_fetch_rows_a(tres, taos_retrieve_call_back, pTable);
  209. }
  210. else {
  211. if (numOfRows < 0)
  212. printf("%s retrieve failed, code:%d\n", pTable->name, numOfRows);
  213. //taos_free_result(tres);
  214. printf("%d rows data retrieved from %s\n", pTable->rowsRetrieved, pTable->name);
  215. tablesSelectProcessed++;
  216. if (tablesSelectProcessed >= numOfTables) {
  217. gettimeofday(&systemTime, NULL);
  218. et = systemTime.tv_sec * 1000000 + systemTime.tv_usec;
  219. printf("%" PRId64 " mseconds to query %d data rows\n", (et - st) / 1000, points * numOfTables);
  220. }
  221. taos_free_result(tres);
  222. }
  223. }
  224. void taos_select_call_back(void *param, TAOS_RES *tres, int code)
  225. {
  226. STable *pTable = (STable *)param;
  227. if (code == 0 && tres) {
  228. // asynchronous API to fetch a batch of records
  229. taos_fetch_rows_a(tres, taos_retrieve_call_back, pTable);
  230. }
  231. else {
  232. printf("%s select failed, code:%d\n", pTable->name, code);
  233. taos_free_result(tres);
  234. taos_cleanup();
  235. exit(1);
  236. }
  237. }

查看源码

参数绑定示例

参数绑定

  1. // TAOS standard API example. The same syntax as MySQL, but only a subet
  2. // to compile: gcc -o prepare prepare.c -ltaos
  3. #include <stdio.h>
  4. #include <stdlib.h>
  5. #include <string.h>
  6. #include "taos.h"
  7. void taosMsleep(int mseconds);
  8. int main(int argc, char *argv[])
  9. {
  10. TAOS *taos;
  11. TAOS_RES *result;
  12. int code;
  13. TAOS_STMT *stmt;
  14. // connect to server
  15. if (argc < 2) {
  16. printf("please input server ip \n");
  17. return 0;
  18. }
  19. taos = taos_connect(argv[1], "root", "taosdata", NULL, 0);
  20. if (taos == NULL) {
  21. printf("failed to connect to db, reason:%s\n", taos_errstr(taos));
  22. exit(1);
  23. }
  24. result = taos_query(taos, "drop database demo");
  25. taos_free_result(result);
  26. result = taos_query(taos, "create database demo");
  27. code = taos_errno(result);
  28. if (code != 0) {
  29. printf("failed to create database, reason:%s\n", taos_errstr(result));
  30. taos_free_result(result);
  31. exit(1);
  32. }
  33. taos_free_result(result);
  34. result = taos_query(taos, "use demo");
  35. taos_free_result(result);
  36. // create table
  37. const char* sql = "create table m1 (ts timestamp, b bool, v1 tinyint, v2 smallint, v4 int, v8 bigint, f4 float, f8 double, bin binary(40), blob nchar(10))";
  38. result = taos_query(taos, sql);
  39. code = taos_errno(result);
  40. if (code != 0) {
  41. printf("failed to create table, reason:%s\n", taos_errstr(result));
  42. taos_free_result(result);
  43. exit(1);
  44. }
  45. taos_free_result(result);
  46. // sleep for one second to make sure table is created on data node
  47. // taosMsleep(1000);
  48. // insert 10 records
  49. struct {
  50. int64_t ts;
  51. int8_t b;
  52. int8_t v1;
  53. int16_t v2;
  54. int32_t v4;
  55. int64_t v8;
  56. float f4;
  57. double f8;
  58. char bin[40];
  59. char blob[80];
  60. } v = {0};
  61. int32_t boolLen = sizeof(int8_t);
  62. int32_t sintLen = sizeof(int16_t);
  63. int32_t intLen = sizeof(int32_t);
  64. int32_t bintLen = sizeof(int64_t);
  65. int32_t floatLen = sizeof(float);
  66. int32_t doubleLen = sizeof(double);
  67. int32_t binLen = sizeof(v.bin);
  68. int32_t ncharLen = 30;
  69. stmt = taos_stmt_init(taos);
  70. TAOS_MULTI_BIND params[10];
  71. params[0].buffer_type = TSDB_DATA_TYPE_TIMESTAMP;
  72. params[0].buffer_length = sizeof(v.ts);
  73. params[0].buffer = &v.ts;
  74. params[0].length = &bintLen;
  75. params[0].is_null = NULL;
  76. params[0].num = 1;
  77. params[1].buffer_type = TSDB_DATA_TYPE_BOOL;
  78. params[1].buffer_length = sizeof(v.b);
  79. params[1].buffer = &v.b;
  80. params[1].length = &boolLen;
  81. params[1].is_null = NULL;
  82. params[1].num = 1;
  83. params[2].buffer_type = TSDB_DATA_TYPE_TINYINT;
  84. params[2].buffer_length = sizeof(v.v1);
  85. params[2].buffer = &v.v1;
  86. params[2].length = &boolLen;
  87. params[2].is_null = NULL;
  88. params[2].num = 1;
  89. params[3].buffer_type = TSDB_DATA_TYPE_SMALLINT;
  90. params[3].buffer_length = sizeof(v.v2);
  91. params[3].buffer = &v.v2;
  92. params[3].length = &sintLen;
  93. params[3].is_null = NULL;
  94. params[3].num = 1;
  95. params[4].buffer_type = TSDB_DATA_TYPE_INT;
  96. params[4].buffer_length = sizeof(v.v4);
  97. params[4].buffer = &v.v4;
  98. params[4].length = &intLen;
  99. params[4].is_null = NULL;
  100. params[4].num = 1;
  101. params[5].buffer_type = TSDB_DATA_TYPE_BIGINT;
  102. params[5].buffer_length = sizeof(v.v8);
  103. params[5].buffer = &v.v8;
  104. params[5].length = &bintLen;
  105. params[5].is_null = NULL;
  106. params[5].num = 1;
  107. params[6].buffer_type = TSDB_DATA_TYPE_FLOAT;
  108. params[6].buffer_length = sizeof(v.f4);
  109. params[6].buffer = &v.f4;
  110. params[6].length = &floatLen;
  111. params[6].is_null = NULL;
  112. params[6].num = 1;
  113. params[7].buffer_type = TSDB_DATA_TYPE_DOUBLE;
  114. params[7].buffer_length = sizeof(v.f8);
  115. params[7].buffer = &v.f8;
  116. params[7].length = &doubleLen;
  117. params[7].is_null = NULL;
  118. params[7].num = 1;
  119. params[8].buffer_type = TSDB_DATA_TYPE_BINARY;
  120. params[8].buffer_length = sizeof(v.bin);
  121. params[8].buffer = v.bin;
  122. params[8].length = &binLen;
  123. params[8].is_null = NULL;
  124. params[8].num = 1;
  125. strcpy(v.blob, "一二三四五六七八九十");
  126. params[9].buffer_type = TSDB_DATA_TYPE_NCHAR;
  127. params[9].buffer_length = sizeof(v.blob);
  128. params[9].buffer = v.blob;
  129. params[9].length = &ncharLen;
  130. params[9].is_null = NULL;
  131. params[9].num = 1;
  132. char is_null = 1;
  133. sql = "insert into m1 values(?,?,?,?,?,?,?,?,?,?)";
  134. code = taos_stmt_prepare(stmt, sql, 0);
  135. if (code != 0){
  136. printf("failed to execute taos_stmt_prepare. code:0x%x\n", code);
  137. }
  138. v.ts = 1591060628000;
  139. for (int i = 0; i < 10; ++i) {
  140. v.ts += 1;
  141. for (int j = 1; j < 10; ++j) {
  142. params[j].is_null = ((i == j) ? &is_null : 0);
  143. }
  144. v.b = (int8_t)i % 2;
  145. v.v1 = (int8_t)i;
  146. v.v2 = (int16_t)(i * 2);
  147. v.v4 = (int32_t)(i * 4);
  148. v.v8 = (int64_t)(i * 8);
  149. v.f4 = (float)(i * 40);
  150. v.f8 = (double)(i * 80);
  151. for (int j = 0; j < sizeof(v.bin); ++j) {
  152. v.bin[j] = (char)(i + '0');
  153. }
  154. taos_stmt_bind_param(stmt, params);
  155. taos_stmt_add_batch(stmt);
  156. }
  157. if (taos_stmt_execute(stmt) != 0) {
  158. printf("failed to execute insert statement.\n");
  159. exit(1);
  160. }
  161. taos_stmt_close(stmt);
  162. // query the records
  163. stmt = taos_stmt_init(taos);
  164. taos_stmt_prepare(stmt, "SELECT * FROM m1 WHERE v1 > ? AND v2 < ?", 0);
  165. v.v1 = 5;
  166. v.v2 = 15;
  167. taos_stmt_bind_param(stmt, params + 2);
  168. if (taos_stmt_execute(stmt) != 0) {
  169. printf("failed to execute select statement.\n");
  170. exit(1);
  171. }
  172. result = taos_stmt_use_result(stmt);
  173. TAOS_ROW row;
  174. int rows = 0;
  175. int num_fields = taos_num_fields(result);
  176. TAOS_FIELD *fields = taos_fetch_fields(result);
  177. // fetch the records row by row
  178. while ((row = taos_fetch_row(result))) {
  179. char temp[256] = {0};
  180. rows++;
  181. taos_print_row(temp, row, fields, num_fields);
  182. printf("%s\n", temp);
  183. }
  184. if (rows == 2) {
  185. printf("two rows are fetched as expectation\n");
  186. } else {
  187. printf("expect two rows, but %d rows are fetched\n", rows);
  188. }
  189. taos_free_result(result);
  190. taos_stmt_close(stmt);
  191. return 0;
  192. }

查看源码

无模式写入示例

无模式写入

  1. #include "taos.h"
  2. #include <stdio.h>
  3. #include <stdlib.h>
  4. #include <sys/time.h>
  5. #include <time.h>
  6. #include <unistd.h>
  7. #include <inttypes.h>
  8. #include <string.h>
  9. int numSuperTables = 8;
  10. int numChildTables = 4;
  11. int numRowsPerChildTable = 2048;
  12. static int64_t getTimeInUs() {
  13. struct timeval systemTime;
  14. gettimeofday(&systemTime, NULL);
  15. return (int64_t)systemTime.tv_sec * 1000000L + (int64_t)systemTime.tv_usec;
  16. }
  17. int main(int argc, char* argv[]) {
  18. TAOS_RES *result;
  19. const char* host = "127.0.0.1";
  20. const char* user = "root";
  21. const char* passwd = "taosdata";
  22. taos_options(TSDB_OPTION_TIMEZONE, "GMT-8");
  23. TAOS* taos = taos_connect(host, user, passwd, "", 0);
  24. if (taos == NULL) {
  25. printf("\033[31mfailed to connect to db, reason:%s\033[0m\n", taos_errstr(taos));
  26. exit(1);
  27. }
  28. const char* info = taos_get_server_info(taos);
  29. printf("server info: %s\n", info);
  30. info = taos_get_client_info(taos);
  31. printf("client info: %s\n", info);
  32. result = taos_query(taos, "drop database if exists db;");
  33. taos_free_result(result);
  34. usleep(100000);
  35. result = taos_query(taos, "create database db precision 'ms';");
  36. taos_free_result(result);
  37. usleep(100000);
  38. (void)taos_select_db(taos, "db");
  39. time_t ct = time(0);
  40. int64_t ts = ct * 1000;
  41. char* lineFormat = "sta%d,t0=true,t1=127i8,t2=32767i16,t3=%di32,t4=9223372036854775807i64,t9=11.12345f32,t10=22.123456789f64,t11=\"binaryTagValue\",t12=L\"ncharTagValue\" c0=true,c1=127i8,c2=32767i16,c3=2147483647i32,c4=9223372036854775807i64,c5=254u8,c6=32770u16,c7=2147483699u32,c8=9223372036854775899u64,c9=11.12345f32,c10=22.123456789f64,c11=\"binaryValue\",c12=L\"ncharValue\" %" PRId64;
  42. int lineNum = numSuperTables * numChildTables * numRowsPerChildTable;
  43. char** lines = calloc((size_t)lineNum, sizeof(char*));
  44. int l = 0;
  45. for (int i = 0; i < numSuperTables; ++i) {
  46. for (int j = 0; j < numChildTables; ++j) {
  47. for (int k = 0; k < numRowsPerChildTable; ++k) {
  48. char* line = calloc(512, 1);
  49. snprintf(line, 512, lineFormat, i, j, ts + 10 * l);
  50. lines[l] = line;
  51. ++l;
  52. }
  53. }
  54. }
  55. printf("%s\n", "begin taos_insert_lines");
  56. int64_t begin = getTimeInUs();
  57. TAOS_RES *res = taos_schemaless_insert(taos, lines, lineNum, TSDB_SML_LINE_PROTOCOL, TSDB_SML_TIMESTAMP_MILLI_SECONDS);
  58. int64_t end = getTimeInUs();
  59. printf("code: %s. time used: %" PRId64 "\n", taos_errstr(res), end-begin);
  60. taos_free_result(res);
  61. return 0;
  62. }

查看源码

订阅和消费示例

订阅和消费

  1. /*
  2. * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
  3. *
  4. * This program is free software: you can use, redistribute, and/or modify
  5. * it under the terms of the GNU Affero General Public License, version 3
  6. * or later ("AGPL"), as published by the Free Software Foundation.
  7. *
  8. * This program is distributed in the hope that it will be useful, but WITHOUT
  9. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10. * FITNESS FOR A PARTICULAR PURPOSE.
  11. *
  12. * You should have received a copy of the GNU Affero General Public License
  13. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. */
  15. #include <assert.h>
  16. #include <stdio.h>
  17. #include <stdlib.h>
  18. #include <string.h>
  19. #include <time.h>
  20. #include "taos.h"
  21. static int running = 1;
  22. static int32_t msg_process(TAOS_RES* msg) {
  23. char buf[1024];
  24. int32_t rows = 0;
  25. const char* topicName = tmq_get_topic_name(msg);
  26. const char* dbName = tmq_get_db_name(msg);
  27. int32_t vgroupId = tmq_get_vgroup_id(msg);
  28. printf("topic: %s\n", topicName);
  29. printf("db: %s\n", dbName);
  30. printf("vgroup id: %d\n", vgroupId);
  31. while (1) {
  32. TAOS_ROW row = taos_fetch_row(msg);
  33. if (row == NULL) break;
  34. TAOS_FIELD* fields = taos_fetch_fields(msg);
  35. int32_t numOfFields = taos_field_count(msg);
  36. // int32_t* length = taos_fetch_lengths(msg);
  37. int32_t precision = taos_result_precision(msg);
  38. rows++;
  39. taos_print_row(buf, row, fields, numOfFields);
  40. printf("precision: %d, row content: %s\n", precision, buf);
  41. }
  42. return rows;
  43. }
  44. static int32_t init_env() {
  45. TAOS* pConn = taos_connect("localhost", "root", "taosdata", NULL, 0);
  46. if (pConn == NULL) {
  47. return -1;
  48. }
  49. TAOS_RES* pRes;
  50. // drop database if exists
  51. printf("create database\n");
  52. pRes = taos_query(pConn, "drop topic topicname");
  53. if (taos_errno(pRes) != 0) {
  54. printf("error in drop topicname, reason:%s\n", taos_errstr(pRes));
  55. }
  56. taos_free_result(pRes);
  57. pRes = taos_query(pConn, "drop database if exists tmqdb");
  58. if (taos_errno(pRes) != 0) {
  59. printf("error in drop tmqdb, reason:%s\n", taos_errstr(pRes));
  60. }
  61. taos_free_result(pRes);
  62. // create database
  63. pRes = taos_query(pConn, "create database tmqdb precision 'ns'");
  64. if (taos_errno(pRes) != 0) {
  65. printf("error in create tmqdb, reason:%s\n", taos_errstr(pRes));
  66. goto END;
  67. }
  68. taos_free_result(pRes);
  69. // create super table
  70. printf("create super table\n");
  71. pRes = taos_query(
  72. pConn, "create table tmqdb.stb (ts timestamp, c1 int, c2 float, c3 varchar(16)) tags(t1 int, t3 varchar(16))");
  73. if (taos_errno(pRes) != 0) {
  74. printf("failed to create super table stb, reason:%s\n", taos_errstr(pRes));
  75. goto END;
  76. }
  77. taos_free_result(pRes);
  78. // create sub tables
  79. printf("create sub tables\n");
  80. pRes = taos_query(pConn, "create table tmqdb.ctb0 using tmqdb.stb tags(0, 'subtable0')");
  81. if (taos_errno(pRes) != 0) {
  82. printf("failed to create super table ctb0, reason:%s\n", taos_errstr(pRes));
  83. goto END;
  84. }
  85. taos_free_result(pRes);
  86. pRes = taos_query(pConn, "create table tmqdb.ctb1 using tmqdb.stb tags(1, 'subtable1')");
  87. if (taos_errno(pRes) != 0) {
  88. printf("failed to create super table ctb1, reason:%s\n", taos_errstr(pRes));
  89. goto END;
  90. }
  91. taos_free_result(pRes);
  92. pRes = taos_query(pConn, "create table tmqdb.ctb2 using tmqdb.stb tags(2, 'subtable2')");
  93. if (taos_errno(pRes) != 0) {
  94. printf("failed to create super table ctb2, reason:%s\n", taos_errstr(pRes));
  95. goto END;
  96. }
  97. taos_free_result(pRes);
  98. pRes = taos_query(pConn, "create table tmqdb.ctb3 using tmqdb.stb tags(3, 'subtable3')");
  99. if (taos_errno(pRes) != 0) {
  100. printf("failed to create super table ctb3, reason:%s\n", taos_errstr(pRes));
  101. goto END;
  102. }
  103. taos_free_result(pRes);
  104. // insert data
  105. printf("insert data into sub tables\n");
  106. pRes = taos_query(pConn, "insert into tmqdb.ctb0 values(now, 0, 0, 'a0')(now+1s, 0, 0, 'a00')");
  107. if (taos_errno(pRes) != 0) {
  108. printf("failed to insert into ctb0, reason:%s\n", taos_errstr(pRes));
  109. goto END;
  110. }
  111. taos_free_result(pRes);
  112. pRes = taos_query(pConn, "insert into tmqdb.ctb1 values(now, 1, 1, 'a1')(now+1s, 11, 11, 'a11')");
  113. if (taos_errno(pRes) != 0) {
  114. printf("failed to insert into ctb0, reason:%s\n", taos_errstr(pRes));
  115. goto END;
  116. }
  117. taos_free_result(pRes);
  118. pRes = taos_query(pConn, "insert into tmqdb.ctb2 values(now, 2, 2, 'a1')(now+1s, 22, 22, 'a22')");
  119. if (taos_errno(pRes) != 0) {
  120. printf("failed to insert into ctb0, reason:%s\n", taos_errstr(pRes));
  121. goto END;
  122. }
  123. taos_free_result(pRes);
  124. pRes = taos_query(pConn, "insert into tmqdb.ctb3 values(now, 3, 3, 'a1')(now+1s, 33, 33, 'a33')");
  125. if (taos_errno(pRes) != 0) {
  126. printf("failed to insert into ctb0, reason:%s\n", taos_errstr(pRes));
  127. goto END;
  128. }
  129. taos_free_result(pRes);
  130. taos_close(pConn);
  131. return 0;
  132. END:
  133. taos_free_result(pRes);
  134. taos_close(pConn);
  135. return -1;
  136. }
  137. int32_t create_topic() {
  138. printf("create topic\n");
  139. TAOS_RES* pRes;
  140. TAOS* pConn = taos_connect("localhost", "root", "taosdata", NULL, 0);
  141. if (pConn == NULL) {
  142. return -1;
  143. }
  144. pRes = taos_query(pConn, "use tmqdb");
  145. if (taos_errno(pRes) != 0) {
  146. printf("error in use tmqdb, reason:%s\n", taos_errstr(pRes));
  147. return -1;
  148. }
  149. taos_free_result(pRes);
  150. pRes = taos_query(pConn, "create topic topicname as select ts, c1, c2, c3, tbname from tmqdb.stb where c1 > 1");
  151. if (taos_errno(pRes) != 0) {
  152. printf("failed to create topic topicname, reason:%s\n", taos_errstr(pRes));
  153. return -1;
  154. }
  155. taos_free_result(pRes);
  156. taos_close(pConn);
  157. return 0;
  158. }
  159. void tmq_commit_cb_print(tmq_t* tmq, int32_t code, void* param) {
  160. printf("tmq_commit_cb_print() code: %d, tmq: %p, param: %p\n", code, tmq, param);
  161. }
  162. tmq_t* build_consumer() {
  163. tmq_conf_res_t code;
  164. tmq_t* tmq = NULL;
  165. tmq_conf_t* conf = tmq_conf_new();
  166. code = tmq_conf_set(conf, "enable.auto.commit", "true");
  167. if (TMQ_CONF_OK != code) {
  168. tmq_conf_destroy(conf);
  169. return NULL;
  170. }
  171. code = tmq_conf_set(conf, "auto.commit.interval.ms", "1000");
  172. if (TMQ_CONF_OK != code) {
  173. tmq_conf_destroy(conf);
  174. return NULL;
  175. }
  176. code = tmq_conf_set(conf, "group.id", "cgrpName");
  177. if (TMQ_CONF_OK != code) {
  178. tmq_conf_destroy(conf);
  179. return NULL;
  180. }
  181. code = tmq_conf_set(conf, "client.id", "user defined name");
  182. if (TMQ_CONF_OK != code) {
  183. tmq_conf_destroy(conf);
  184. return NULL;
  185. }
  186. code = tmq_conf_set(conf, "td.connect.user", "root");
  187. if (TMQ_CONF_OK != code) {
  188. tmq_conf_destroy(conf);
  189. return NULL;
  190. }
  191. code = tmq_conf_set(conf, "td.connect.pass", "taosdata");
  192. if (TMQ_CONF_OK != code) {
  193. tmq_conf_destroy(conf);
  194. return NULL;
  195. }
  196. code = tmq_conf_set(conf, "auto.offset.reset", "earliest");
  197. if (TMQ_CONF_OK != code) {
  198. tmq_conf_destroy(conf);
  199. return NULL;
  200. }
  201. code = tmq_conf_set(conf, "experimental.snapshot.enable", "false");
  202. if (TMQ_CONF_OK != code) {
  203. tmq_conf_destroy(conf);
  204. return NULL;
  205. }
  206. tmq_conf_set_auto_commit_cb(conf, tmq_commit_cb_print, NULL);
  207. tmq = tmq_consumer_new(conf, NULL, 0);
  208. _end:
  209. tmq_conf_destroy(conf);
  210. return tmq;
  211. }
  212. tmq_list_t* build_topic_list() {
  213. tmq_list_t* topicList = tmq_list_new();
  214. int32_t code = tmq_list_append(topicList, "topicname");
  215. if (code) {
  216. tmq_list_destroy(topicList);
  217. return NULL;
  218. }
  219. return topicList;
  220. }
  221. void basic_consume_loop(tmq_t* tmq) {
  222. int32_t totalRows = 0;
  223. int32_t msgCnt = 0;
  224. int32_t timeout = 5000;
  225. while (running) {
  226. TAOS_RES* tmqmsg = tmq_consumer_poll(tmq, timeout);
  227. if (tmqmsg) {
  228. msgCnt++;
  229. totalRows += msg_process(tmqmsg);
  230. taos_free_result(tmqmsg);
  231. } else {
  232. break;
  233. }
  234. }
  235. fprintf(stderr, "%d msg consumed, include %d rows\n", msgCnt, totalRows);
  236. }
  237. int main(int argc, char* argv[]) {
  238. int32_t code;
  239. if (init_env() < 0) {
  240. return -1;
  241. }
  242. if (create_topic() < 0) {
  243. return -1;
  244. }
  245. tmq_t* tmq = build_consumer();
  246. if (NULL == tmq) {
  247. fprintf(stderr, "build_consumer() fail!\n");
  248. return -1;
  249. }
  250. tmq_list_t* topic_list = build_topic_list();
  251. if (NULL == topic_list) {
  252. return -1;
  253. }
  254. if ((code = tmq_subscribe(tmq, topic_list))) {
  255. fprintf(stderr, "Failed to tmq_subscribe(): %s\n", tmq_err2str(code));
  256. }
  257. tmq_list_destroy(topic_list);
  258. basic_consume_loop(tmq);
  259. code = tmq_consumer_close(tmq);
  260. if (code) {
  261. fprintf(stderr, "Failed to close consumer: %s\n", tmq_err2str(code));
  262. } else {
  263. fprintf(stderr, "Consumer closed\n");
  264. }
  265. return 0;
  266. }

查看源码

C/C++ - 图2info

更多示例代码及下载请见 GitHub。 也可以在安装目录下的 examples/c 路径下找到。 该目录下有 makefile,在 Linux/macOS 环境下,直接执行 make 就可以编译得到执行文件。 提示:在 ARM 环境下编译时,请将 makefile 中的 -msse4.2 去掉,这个选项只有在 x64/x86 硬件平台上才能支持。

API 参考

以下分别介绍 TDengine 客户端驱动的基础 API、同步 API、异步 API、订阅 API 和无模式写入 API。

基础 API

基础 API 用于完成创建数据库连接等工作,为其它 API 的执行提供运行时环境。

  • void taos_init()

    初始化运行环境。如果没有主动调用该 API,那么调用 taos_connect() 时驱动将自动调用该 API,故程序一般无需手动调用。

  • void taos_cleanup()

    清理运行环境,应用退出前应调用。

  • int taos_options(TSDB_OPTION option, const void * arg, ...)

    设置客户端选项,目前支持区域设置(TSDB_OPTION_LOCALE)、字符集设置(TSDB_OPTION_CHARSET)、时区设置(TSDB_OPTION_TIMEZONE)、配置文件路径设置(TSDB_OPTION_CONFIGDIR)。区域设置、字符集、时区默认为操作系统当前设置。

  • char *taos_get_client_info()

    获取客户端版本信息。

  • TAOS *taos_connect(const char *host, const char *user, const char *pass, const char *db, int port)

    创建数据库连接,初始化连接上下文。其中需要用户提供的参数包含:

    • host:TDengine 集群中任一节点的 FQDN
    • user:用户名
    • pass:密码
    • db: 数据库名字,如果用户没有提供,也可以正常连接,用户可以通过该连接创建新的数据库,如果用户提供了数据库名字,则说明该数据库用户已经创建好,缺省使用该数据库
    • port:taosd 程序监听的端口

    返回值为空表示失败。应用程序需要保存返回的参数,以便后续使用。

    C/C++ - 图3info

    同一进程可以根据不同的 host/port 连接多个 TDengine 集群

  • char *taos_get_server_info(TAOS *taos)

    获取服务端版本信息。

  • int taos_select_db(TAOS *taos, const char *db)

    将当前的缺省数据库设置为 db

  • int taos_get_current_db(TAOS *taos, char *database, int len, int *required)

    • database,len为用户在外面申请的空间,内部会把当前db赋值到database里。
    • 只要是没有正常把db名赋值到database中(包括截断),返回错误,返回值为-1,然后用户可以通过 taos_errstr(NULL) 来获取错误提示。
    • 如果,database == NULL 或者 len<=0 返回错误,required里保存存储db需要的空间(包含最后的’\0’)
    • 如果,len 小于 存储db需要的空间(包含最后的’\0’),返回错误,database里赋值截断的数据,以’\0’结尾。
    • 如果,len 大于等于 存储db需要的空间(包含最后的’\0’),返回正常0,database里赋值以’\0‘结尾的db名。
  • void taos_close(TAOS *taos)

    关闭连接,其中taostaos_connect() 返回的句柄。

同步查询 API

本小节介绍 API 均属于同步接口。应用调用后,会阻塞等待响应,直到获得返回结果或错误信息。

  • TAOS_RES* taos_query(TAOS *taos, const char *sql)

    执行 SQL 语句,可以是 DQL、DML 或 DDL 语句。 其中的 taos 参数是通过 taos_connect() 获得的句柄。不能通过返回值是否是 NULL 来判断执行结果是否失败,而是需要用 taos_errno() 函数解析结果集中的错误代码来进行判断。

  • int taos_result_precision(TAOS_RES *res)

    返回结果集时间戳字段的精度,0 代表毫秒,1 代表微秒,2 代表纳秒。

  • TAOS_ROW taos_fetch_row(TAOS_RES *res)

    按行获取查询结果集中的数据。

  • int taos_fetch_block(TAOS_RES *res, TAOS_ROW *rows)

    批量获取查询结果集中的数据,返回值为获取到的数据的行数。

  • int taos_num_fields(TAOS_RES *res)int taos_field_count(TAOS_RES *res)

    这两个 API 等价,用于获取查询结果集中的列数。

  • int* taos_fetch_lengths(TAOS_RES *res)

    获取结果集中每个字段的长度。返回值是一个数组,其长度为结果集的列数。

  • int taos_affected_rows(TAOS_RES *res)

    获取被所执行的 SQL 语句影响的行数。

  • TAOS_FIELD *taos_fetch_fields(TAOS_RES *res)

    获取查询结果集每列数据的属性(列的名称、列的数据类型、列的长度),与 taos_num_fields() 配合使用,可用来解析 taos_fetch_row() 返回的一个元组(一行)的数据。 TAOS_FIELD 的结构如下:

  1. typedef struct taosField {
  2. char name[65]; // column name
  3. uint8_t type; // data type
  4. int16_t bytes; // length, in bytes
  5. } TAOS_FIELD;
  • void taos_stop_query(TAOS_RES *res)

    停止当前查询的执行。

  • void taos_free_result(TAOS_RES *res)

    释放查询结果集以及相关的资源。查询完成后,务必调用该 API 释放资源,否则可能导致应用内存泄露。但也需注意,释放资源后,如果再调用 taos_consume() 等获取查询结果的函数,将导致应用崩溃。

  • char *taos_errstr(TAOS_RES *res)

    获取最近一次 API 调用失败的原因,返回值为字符串标识的错误提示信息。

  • int taos_errno(TAOS_RES *res)

    获取最近一次 API 调用失败的原因,返回值为错误代码。

C/C++ - 图4note

2.0 及以上版本 TDengine 推荐数据库应用的每个线程都建立一个独立的连接,或基于线程建立连接池。而不推荐在应用中将该连接 (TAOS*) 结构体传递到不同的线程共享使用。基于 TAOS 结构体发出的查询、写入等操作具有多线程安全性,但 “USE statement” 等状态量有可能在线程之间相互干扰。此外,C 语言的连接器可以按照需求动态建立面向数据库的新连接(该过程对用户不可见),同时建议只有在程序最后退出的时候才调用 taos_close() 关闭连接。 另一个需要注意的是,在上述同步 API 执行过程中,不能调用类似 pthread_cancel 之类的 API 来强制结束线程,因为涉及一些模块的同步操作,如果强制结束线程有可能造成包括但不限于死锁等异常状况。

异步查询 API

TDengine 还提供性能更高的异步 API 处理数据插入、查询操作。在软硬件环境相同的情况下,异步 API 处理数据插入的速度比同步 API 快 2 ~ 4 倍。异步 API 采用非阻塞式的调用方式,在系统真正完成某个具体数据库操作前,立即返回。调用的线程可以去处理其他工作,从而可以提升整个应用的性能。异步 API 在网络延迟严重的情况下,优势尤为突出。

异步 API 都需要应用提供相应的回调函数,回调函数参数设置如下:前两个参数都是一致的,第三个参数依不同的 API 而定。第一个参数 param 是应用调用异步 API 时提供给系统的,用于回调时,应用能够找回具体操作的上下文,依具体实现而定。第二个参数是 SQL 操作的结果集,如果为空,比如 insert 操作,表示没有记录返回,如果不为空,比如 select 操作,表示有记录返回。

异步 API 对于使用者的要求相对较高,用户可根据具体应用场景选择性使用。下面是两个重要的异步 API:

  • void taos_query_a(TAOS *taos, const char *sql, void (*fp)(void *param, TAOS_RES *, int code), void *param);

    异步执行 SQL 语句。

    • taos:调用 taos_connect() 返回的数据库连接
    • sql:需要执行的 SQL 语句
    • fp:用户定义的回调函数,其第三个参数 code 用于指示操作是否成功,0 表示成功,负数表示失败(调用 taos_errstr() 可获取失败原因)。应用在定义回调函数的时候,主要处理第二个参数 TAOS_RES *,该参数是查询返回的结果集
    • param:应用提供一个用于回调的参数
  • void taos_fetch_rows_a(TAOS_RES *res, void (*fp)(void *param, TAOS_RES *, int numOfRows), void *param);

    批量获取异步查询的结果集,只能与 taos_query_a() 配合使用。其中:

    • res:taos_query_a() 回调时返回的结果集
    • fp:回调函数。其参数 param 是用户可定义的传递给回调函数的参数结构体;numOfRows 是获取到的数据的行数(不是整个查询结果集的函数)。 在回调函数中,应用可以通过调用 taos_fetch_row() 前向迭代获取批量记录中每一行记录。读完一块内的所有记录后,应用需要在回调函数中继续调用 taos_fetch_rows_a() 获取下一批记录进行处理,直到返回的记录数 numOfRows 为零(结果返回完成)或记录数为负值(查询出错)。

TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多线程同时打开多张表,并可以同时对每张打开的表进行查询或者插入操作。需要指出的是,客户端应用必须确保对同一张表的操作完全串行化,即对同一个表的插入或查询操作未完成时(未返回时),不能够执行第二个插入或查询操作。

参数绑定 API

除了直接调用 taos_query() 进行查询,TDengine 也提供了支持参数绑定的 Prepare API,风格与 MySQL 类似,目前也仅支持用问号 ? 来代表待绑定的参数。

从 2.1.1.0 和 2.1.2.0 版本开始,TDengine 大幅改进了参数绑定接口对数据写入(INSERT)场景的支持。这样在通过参数绑定接口写入数据时,就避免了 SQL 语法解析的资源消耗,从而在绝大多数情况下显著提升写入性能。此时的典型操作步骤如下:

  1. 调用 taos_stmt_init() 创建参数绑定对象;
  2. 调用 taos_stmt_prepare() 解析 INSERT 语句;
  3. 如果 INSERT 语句中预留了表名但没有预留 TAGS,那么调用 taos_stmt_set_tbname() 来设置表名;
  4. 如果 INSERT 语句中既预留了表名又预留了 TAGS(例如 INSERT 语句采取的是自动建表的方式),那么调用 taos_stmt_set_tbname_tags() 来设置表名和 TAGS 的值;
  5. 调用 taos_stmt_bind_param_batch() 以多行的方式设置 VALUES 的值,或者调用 taos_stmt_bind_param() 以单行的方式设置 VALUES 的值;
  6. 调用 taos_stmt_add_batch() 把当前绑定的参数加入批处理;
  7. 可以重复第 3 ~ 6 步,为批处理加入更多的数据行;
  8. 调用 taos_stmt_execute() 执行已经准备好的批处理指令;
  9. 执行完毕,调用 taos_stmt_close() 释放所有资源。

说明:如果 taos_stmt_execute() 执行成功,假如不需要改变 SQL 语句的话,那么是可以复用 taos_stmt_prepare() 的解析结果,直接进行第 3 ~ 6 步绑定新数据的。但如果执行出错,那么并不建议继续在当前的环境上下文下继续工作,而是建议释放资源,然后从 taos_stmt_init() 步骤重新开始。

接口相关的具体函数如下(也可以参考 prepare.c 文件中使用对应函数的方式):

  • TAOS_STMT* taos_stmt_init(TAOS *taos)

    创建一个 TAOS_STMT 对象用于后续调用。

  • int taos_stmt_prepare(TAOS_STMT *stmt, const char *sql, unsigned long length)

    解析一条 SQL 语句,将解析结果和参数信息绑定到 stmt 上,如果参数 length 大于 0,将使用此参数作为 SQL 语句的长度,如等于 0,将自动判断 SQL 语句的长度。

  • int taos_stmt_bind_param(TAOS_STMT *stmt, TAOS_BIND *bind)

    不如 taos_stmt_bind_param_batch() 效率高,但可以支持非 INSERT 类型的 SQL 语句。 进行参数绑定,bind 指向一个数组(代表所要绑定的一行数据),需保证此数组中的元素数量和顺序与 SQL 语句中的参数完全一致。TAOS_BIND 的使用方法与 MySQL 中的 MYSQL_BIND 类似,具体定义如下:

    1. typedef struct TAOS_BIND {
    2. int buffer_type;
    3. void * buffer;
    4. uintptr_t buffer_length; // not in use
    5. uintptr_t * length;
    6. int * is_null;
    7. int is_unsigned; // not in use
    8. int * error; // not in use
    9. } TAOS_BIND;
  • int taos_stmt_set_tbname(TAOS_STMT* stmt, const char* name)

    (2.1.1.0 版本新增,仅支持用于替换 INSERT 语句中的参数值) 当 SQL 语句中的表名使用了 ? 占位时,可以使用此函数绑定一个具体的表名。

  • int taos_stmt_set_tbname_tags(TAOS_STMT* stmt, const char* name, TAOS_BIND* tags)

    (2.1.2.0 版本新增,仅支持用于替换 INSERT 语句中的参数值) 当 SQL 语句中的表名和 TAGS 都使用了 ? 占位时,可以使用此函数绑定具体的表名和具体的 TAGS 取值。最典型的使用场景是使用了自动建表功能的 INSERT 语句(目前版本不支持指定具体的 TAGS 列)。TAGS 参数中的列数量需要与 SQL 语句中要求的 TAGS 数量完全一致。

  • int taos_stmt_bind_param_batch(TAOS_STMT* stmt, TAOS_MULTI_BIND* bind)

    (2.1.1.0 版本新增,仅支持用于替换 INSERT 语句中的参数值) 以多列的方式传递待绑定的数据,需要保证这里传递的数据列的顺序、列的数量与 SQL 语句中的 VALUES 参数完全一致。TAOS_MULTI_BIND 的具体定义如下:

    1. typedef struct TAOS_MULTI_BIND {
    2. int buffer_type;
    3. void * buffer;
    4. uintptr_t buffer_length;
    5. uintptr_t * length;
    6. char * is_null;
    7. int num; // the number of columns
    8. } TAOS_MULTI_BIND;
  • int taos_stmt_add_batch(TAOS_STMT *stmt)

    将当前绑定的参数加入批处理中,调用此函数后,可以再次调用 taos_stmt_bind_param()taos_stmt_bind_param_batch() 绑定新的参数。需要注意,此函数仅支持 INSERT/IMPORT 语句,如果是 SELECT 等其他 SQL 语句,将返回错误。

  • int taos_stmt_execute(TAOS_STMT *stmt)

    执行准备好的语句。目前,一条语句只能执行一次。

  • TAOS_RES* taos_stmt_use_result(TAOS_STMT *stmt)

    获取语句的结果集。结果集的使用方式与非参数化调用时一致,使用完成后,应对此结果集调用 taos_free_result() 以释放资源。

  • int taos_stmt_close(TAOS_STMT *stmt)

    执行完毕,释放所有资源。

  • char * taos_stmt_errstr(TAOS_STMT *stmt)

    (2.1.3.0 版本新增) 用于在其他 STMT API 返回错误(返回错误码或空指针)时获取错误信息。

无模式(schemaless)写入 API

除了使用 SQL 方式或者使用参数绑定 API 写入数据外,还可以使用 Schemaless 的方式完成写入。Schemaless 可以免于预先创建超级表/数据子表的数据结构,而是可以直接写入数据,TDengine 系统会根据写入的数据内容自动创建和维护所需要的表结构。Schemaless 的使用方式详见 Schemaless 写入 章节,这里介绍与之配套使用的 C/C++ API。

  • TAOS_RES* taos_schemaless_insert(TAOS* taos, const char* lines[], int numLines, int protocol, int precision)

    功能说明 该接口将行协议的文本数据写入到 TDengine 中。

    参数说明 taos: 数据库连接,通过 taos_connect() 函数建立的数据库连接。 lines:文本数据。满足解析格式要求的无模式文本字符串。 numLines:文本数据的行数,不能为 0 。 protocol: 行协议类型,用于标识文本数据格式。 precision:文本数据中的时间戳精度字符串。

    返回值 TAOS_RES 结构体,应用可以通过使用 taos_errstr() 获得错误信息,也可以使用 taos_errno() 获得错误码。 在某些情况下,返回的 TAOS_RES 为 NULL,此时仍然可以调用 taos_errno() 来安全地获得错误码信息。 返回的 TAOS_RES 需要调用方来负责释放,否则会出现内存泄漏。

    说明 协议类型是枚举类型,包含以下三种格式:

    • TSDB_SML_LINE_PROTOCOL:InfluxDB 行协议(Line Protocol)
    • TSDB_SML_TELNET_PROTOCOL: OpenTSDB Telnet 文本行协议
    • TSDB_SML_JSON_PROTOCOL: OpenTSDB Json 协议格式

    时间戳分辨率的定义,定义在 taos.h 文件中,具体内容如下:

    • TSDB_SML_TIMESTAMP_NOT_CONFIGURED = 0,
    • TSDB_SML_TIMESTAMP_HOURS,
    • TSDB_SML_TIMESTAMP_MINUTES,
    • TSDB_SML_TIMESTAMP_SECONDS,
    • TSDB_SML_TIMESTAMP_MILLI_SECONDS,
    • TSDB_SML_TIMESTAMP_MICRO_SECONDS,
    • TSDB_SML_TIMESTAMP_NANO_SECONDS

    需要注意的是,时间戳分辨率参数只在协议类型为 SML_LINE_PROTOCOL 的时候生效。 对于 OpenTSDB 的文本协议,时间戳的解析遵循其官方解析规则 — 按照时间戳包含的字符的数量来确认时间精度。

    schemaless 其他相关的接口

  • TAOS_RES *taos_schemaless_insert_with_reqid(TAOS *taos, char *lines[], int numLines, int protocol, int precision, int64_t reqid)

  • TAOS_RES *taos_schemaless_insert_raw(TAOS *taos, char *lines, int len, int32_t *totalRows, int protocol, int precision)

  • TAOS_RES *taos_schemaless_insert_raw_with_reqid(TAOS *taos, char *lines, int len, int32_t *totalRows, int protocol, int precision, int64_t reqid)

  • TAOS_RES *taos_schemaless_insert_ttl(TAOS *taos, char *lines[], int numLines, int protocol, int precision, int32_t ttl)

  • TAOS_RES *taos_schemaless_insert_ttl_with_reqid(TAOS *taos, char *lines[], int numLines, int protocol, int precision, int32_t ttl, int64_t reqid)

  • TAOS_RES *taos_schemaless_insert_raw_ttl(TAOS *taos, char *lines, int len, int32_t *totalRows, int protocol, int precision, int32_t ttl)

  • TAOS_RES *taos_schemaless_insert_raw_ttl_with_reqid(TAOS *taos, char *lines, int len, int32_t *totalRows, int protocol, int precision, int32_t ttl, int64_t reqid)

    说明

    • 上面这7个接口是扩展接口,主要用于在schemaless写入时传递ttl、reqid参数,可以根据需要使用。
    • 带_raw的接口通过传递的参数lines指针和长度len来表示数据,为了解决原始接口数据包含’\0’而被截断的问题。totalRows指针返回解析出来的数据行数。
    • 带_ttl的接口可以传递ttl参数来控制建表的ttl到期时间。
    • 带_reqid的接口可以通过传递reqid参数来追踪整个的调用链。