taos.h 6.8 KB
Newer Older
H
hzcheng 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
 * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
 *
 * This program is free software: you can use, redistribute, and/or modify
 * it under the terms of the GNU Affero General Public License, version 3
 * or later ("AGPL"), as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef TDENGINE_TAOS_H
#define TDENGINE_TAOS_H

#include <stdint.h>
H
Haojun Liao 已提交
20
#include <stdbool.h>
H
hzcheng 已提交
21 22 23 24 25

#ifdef __cplusplus
extern "C" {
#endif

S
Shengliang Guan 已提交
26 27 28 29 30 31
typedef void   TAOS;
typedef void   TAOS_STMT;
typedef void   TAOS_RES;
typedef void   TAOS_STREAM;
typedef void   TAOS_SUB;
typedef void **TAOS_ROW;
H
hzcheng 已提交
32

H
hzcheng 已提交
33
// Data type definition
S
Shengliang Guan 已提交
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
#define TSDB_DATA_TYPE_NULL       0     // 1 bytes
#define TSDB_DATA_TYPE_BOOL       1     // 1 bytes
#define TSDB_DATA_TYPE_TINYINT    2     // 1 byte
#define TSDB_DATA_TYPE_SMALLINT   3     // 2 bytes
#define TSDB_DATA_TYPE_INT        4     // 4 bytes
#define TSDB_DATA_TYPE_BIGINT     5     // 8 bytes
#define TSDB_DATA_TYPE_FLOAT      6     // 4 bytes
#define TSDB_DATA_TYPE_DOUBLE     7     // 8 bytes
#define TSDB_DATA_TYPE_BINARY     8     // string
#define TSDB_DATA_TYPE_TIMESTAMP  9     // 8 bytes
#define TSDB_DATA_TYPE_NCHAR      10    // unicode string
#define TSDB_DATA_TYPE_UTINYINT   11    // 1 byte
#define TSDB_DATA_TYPE_USMALLINT  12    // 2 bytes
#define TSDB_DATA_TYPE_UINT       13    // 4 bytes
#define TSDB_DATA_TYPE_UBIGINT    14    // 8 bytes
H
hzcheng 已提交
49

H
hzcheng 已提交
50 51 52 53 54 55 56 57 58
typedef enum {
  TSDB_OPTION_LOCALE,
  TSDB_OPTION_CHARSET,
  TSDB_OPTION_TIMEZONE,
  TSDB_OPTION_CONFIGDIR,
  TSDB_OPTION_SHELL_ACTIVITY_TIMER,
  TSDB_MAX_OPTIONS
} TSDB_OPTION;

S
slguan 已提交
59
typedef struct taosField {
B
Bomin Zhang 已提交
60
  char     name[65];
61
  uint8_t  type;
62
  int16_t  bytes;
H
hzcheng 已提交
63 64
} TAOS_FIELD;

L
[#1054]  
lihui 已提交
65 66 67 68 69 70
#ifdef _TD_GO_DLL_
  #define DLL_EXPORT    __declspec(dllexport)
#else
  #define DLL_EXPORT 
#endif

D
fix bug  
dapan1121 已提交
71
DLL_EXPORT int  taos_init();
S
Shengliang Guan 已提交
72
DLL_EXPORT void  taos_cleanup(void);
L
[#1054]  
lihui 已提交
73 74
DLL_EXPORT int   taos_options(TSDB_OPTION option, const void *arg, ...);
DLL_EXPORT TAOS *taos_connect(const char *ip, const char *user, const char *pass, const char *db, uint16_t port);
75
DLL_EXPORT TAOS *taos_connect_auth(const char *ip, const char *user, const char *auth, const char *db, uint16_t port);
L
[#1054]  
lihui 已提交
76
DLL_EXPORT void  taos_close(TAOS *taos);
S
slguan 已提交
77

F
freemine 已提交
78 79
const char *taos_data_type(int type);

S
slguan 已提交
80 81 82
typedef struct TAOS_BIND {
  int            buffer_type;
  void *         buffer;
83 84
  uintptr_t      buffer_length;  // unused
  uintptr_t      *length;
S
slguan 已提交
85
  int *          is_null;
D
fix bug  
dapan1121 已提交
86

S
slguan 已提交
87 88
  int            is_unsigned;  // unused
  int *          error;        // unused
F
freemine 已提交
89 90 91 92 93 94 95 96 97 98 99 100 101
  union {
    int64_t        ts;
    int8_t         b;
    int8_t         v1;
    int16_t        v2;
    int32_t        v4;
    int64_t        v8;
    float          f4;
    double         f8;
    unsigned char *bin;
    char          *nchar;
  } u;
  unsigned int     allocated;
S
slguan 已提交
102 103
} TAOS_BIND;

D
fix bug  
dapan1121 已提交
104 105
typedef struct TAOS_MULTI_BIND {
  int            buffer_type;
H
Haojun Liao 已提交
106 107
  void          *buffer;
  uintptr_t      buffer_length;
108 109
  int32_t       *length;
  char          *is_null;
D
fix bug  
dapan1121 已提交
110 111 112
  int            num;
} TAOS_MULTI_BIND;

113 114 115 116
DLL_EXPORT TAOS_STMT *taos_stmt_init(TAOS *taos);
DLL_EXPORT int        taos_stmt_prepare(TAOS_STMT *stmt, const char *sql, unsigned long length);
DLL_EXPORT int        taos_stmt_set_tbname_tags(TAOS_STMT* stmt, const char* name, TAOS_BIND* tags);
DLL_EXPORT int        taos_stmt_set_tbname(TAOS_STMT* stmt, const char* name);
117
DLL_EXPORT int        taos_stmt_set_sub_tbname(TAOS_STMT* stmt, const char* name);
S
Shengliang Guan 已提交
118

119 120
DLL_EXPORT int        taos_stmt_is_insert(TAOS_STMT *stmt, int *insert);
DLL_EXPORT int        taos_stmt_num_params(TAOS_STMT *stmt, int *nums);
S
Shengliang Guan 已提交
121
DLL_EXPORT int        taos_stmt_get_param(TAOS_STMT *stmt, int idx, int *type, int *bytes);
122
DLL_EXPORT int        taos_stmt_bind_param(TAOS_STMT *stmt, TAOS_BIND *bind);
S
Shengliang Guan 已提交
123 124
DLL_EXPORT int        taos_stmt_bind_param_batch(TAOS_STMT* stmt, TAOS_MULTI_BIND* bind);
DLL_EXPORT int        taos_stmt_bind_single_param_batch(TAOS_STMT* stmt, TAOS_MULTI_BIND* bind, int colIdx);
125 126 127 128 129
DLL_EXPORT int        taos_stmt_add_batch(TAOS_STMT *stmt);
DLL_EXPORT int        taos_stmt_execute(TAOS_STMT *stmt);
DLL_EXPORT TAOS_RES * taos_stmt_use_result(TAOS_STMT *stmt);
DLL_EXPORT int        taos_stmt_close(TAOS_STMT *stmt);
DLL_EXPORT char *     taos_stmt_errstr(TAOS_STMT *stmt);
S
slguan 已提交
130

H
Haojun Liao 已提交
131
DLL_EXPORT TAOS_RES *taos_query(TAOS *taos, const char *sql);
L
[#1054]  
lihui 已提交
132 133 134
DLL_EXPORT TAOS_ROW taos_fetch_row(TAOS_RES *res);
DLL_EXPORT int taos_result_precision(TAOS_RES *res);  // get the time precision of result
DLL_EXPORT void taos_free_result(TAOS_RES *res);
H
Haojun Liao 已提交
135
DLL_EXPORT int taos_field_count(TAOS_RES *res);
L
[#1054]  
lihui 已提交
136
DLL_EXPORT int taos_num_fields(TAOS_RES *res);
137
DLL_EXPORT int taos_affected_rows(TAOS_RES *res);
L
[#1054]  
lihui 已提交
138 139 140 141
DLL_EXPORT TAOS_FIELD *taos_fetch_fields(TAOS_RES *res);
DLL_EXPORT int taos_select_db(TAOS *taos, const char *db);
DLL_EXPORT int taos_print_row(char *str, TAOS_ROW row, TAOS_FIELD *fields, int num_fields);
DLL_EXPORT void taos_stop_query(TAOS_RES *res);
H
Haojun Liao 已提交
142
DLL_EXPORT bool taos_is_null(TAOS_RES *res, int32_t row, int32_t col);
143 144
DLL_EXPORT int taos_fetch_block(TAOS_RES *res, TAOS_ROW *rows);
DLL_EXPORT int taos_validate_sql(TAOS *taos, const char *sql);
H
hzcheng 已提交
145

146
DLL_EXPORT int* taos_fetch_lengths(TAOS_RES *res);
147

H
hzcheng 已提交
148 149 150
// TAOS_RES   *taos_list_tables(TAOS *mysql, const char *wild);
// TAOS_RES   *taos_list_dbs(TAOS *mysql, const char *wild);

S
slguan 已提交
151
// TODO: the return value should be `const`
L
[#1054]  
lihui 已提交
152 153
DLL_EXPORT char *taos_get_server_info(TAOS *taos);
DLL_EXPORT char *taos_get_client_info();
H
Haojun Liao 已提交
154
DLL_EXPORT char *taos_errstr(TAOS_RES *tres);
S
slguan 已提交
155

H
Haojun Liao 已提交
156
DLL_EXPORT int taos_errno(TAOS_RES *tres);
H
hzcheng 已提交
157

L
[#1054]  
lihui 已提交
158 159
DLL_EXPORT void taos_query_a(TAOS *taos, const char *sql, void (*fp)(void *param, TAOS_RES *, int code), void *param);
DLL_EXPORT void taos_fetch_rows_a(TAOS_RES *res, void (*fp)(void *param, TAOS_RES *, int numOfRows), void *param);
H
Haojun Liao 已提交
160
//DLL_EXPORT void taos_fetch_row_a(TAOS_RES *res, void (*fp)(void *param, TAOS_RES *, TAOS_ROW row), void *param);
H
hzcheng 已提交
161

weixin_48148422's avatar
weixin_48148422 已提交
162
typedef void (*TAOS_SUBSCRIBE_CALLBACK)(TAOS_SUB* tsub, TAOS_RES *res, void* param, int code);
weixin_48148422's avatar
weixin_48148422 已提交
163
DLL_EXPORT TAOS_SUB *taos_subscribe(TAOS* taos, int restart, const char* topic, const char *sql, TAOS_SUBSCRIBE_CALLBACK fp, void *param, int interval);
weixin_48148422's avatar
weixin_48148422 已提交
164
DLL_EXPORT TAOS_RES *taos_consume(TAOS_SUB *tsub);
weixin_48148422's avatar
weixin_48148422 已提交
165
DLL_EXPORT void      taos_unsubscribe(TAOS_SUB *tsub, int keepProgress);
H
hzcheng 已提交
166

L
[#1054]  
lihui 已提交
167
DLL_EXPORT TAOS_STREAM *taos_open_stream(TAOS *taos, const char *sql, void (*fp)(void *param, TAOS_RES *, TAOS_ROW row),
H
hzcheng 已提交
168
                              int64_t stime, void *param, void (*callback)(void *));
L
[#1054]  
lihui 已提交
169
DLL_EXPORT void taos_close_stream(TAOS_STREAM *tstr);
H
hzcheng 已提交
170

L
[#1054]  
lihui 已提交
171
DLL_EXPORT int taos_load_table_info(TAOS *taos, const char* tableNameList);
S
slguan 已提交
172

173
DLL_EXPORT int taos_insert_lines(TAOS* taos, char* lines[], int numLines);
174

H
hzcheng 已提交
175 176 177 178 179
#ifdef __cplusplus
}
#endif

#endif