tsclient.h 13.5 KB
Newer Older
H
hzcheng 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*
 * 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_TSCLIENT_H
#define TDENGINE_TSCLIENT_H

#ifdef __cplusplus
extern "C" {
#endif

S
slguan 已提交
23
#include "os.h"
24

H
hzcheng 已提交
25
#include "taos.h"
26
#include "taosdef.h"
H
hzcheng 已提交
27
#include "taosmsg.h"
H
hjxilinx 已提交
28
#include "tarray.h"
S
slguan 已提交
29
#include "tglobal.h"
30
#include "tsqlfunction.h"
H
hjxilinx 已提交
31 32
#include "tutil.h"

33
#include "qExecutor.h"
H
hjxilinx 已提交
34 35 36
#include "qsqlparser.h"
#include "qsqltype.h"
#include "qtsbuf.h"
H
hzcheng 已提交
37 38 39

// forward declaration
struct SSqlInfo;
H
hjxilinx 已提交
40 41 42 43 44 45 46
struct SLocalReducer;

// data source from sql string or from file
enum {
  DATA_FROM_SQL_STRING = 1,
  DATA_FROM_DATA_FILE = 2,
};
H
hzcheng 已提交
47

H
hjxilinx 已提交
48
typedef struct STableComInfo {
H
hjxilinx 已提交
49 50 51 52
  uint8_t numOfTags;
  uint8_t precision;
  int16_t numOfColumns;
  int16_t rowSize;
H
hjxilinx 已提交
53
} STableComInfo;
H
hjxilinx 已提交
54 55

typedef struct STableMeta {
H
hjxilinx 已提交
56 57 58 59 60 61 62
  // super table if it is created according to super table, otherwise, tableInfo is used
  union {
    struct STableMeta *pSTable;
    STableComInfo      tableInfo;
  };
  uint8_t       tableType;
  int16_t       sversion;
H
hjxilinx 已提交
63
  SCMVgroupInfo vgroupInfo;
H
hjxilinx 已提交
64 65 66
  int32_t       sid;       // the index of one table in a virtual node
  uint64_t      uid;       // unique id of a table
  SSchema       schema[];  // if the table is TSDB_CHILD_TABLE, schema is acquired by super table meta info
H
hjxilinx 已提交
67 68 69
} STableMeta;

typedef struct STableMetaInfo {
70
  STableMeta *  pTableMeta;      // table meta, cached in client side and acquired by name
H
hjxilinx 已提交
71
  SVgroupsInfo *vgroupList;
72 73
  SArray       *pVgroupTables;   // SArray<SVgroupTableInfo>
  
H
hjxilinx 已提交
74
  /*
H
hjxilinx 已提交
75 76
   * 1. keep the vgroup index during the multi-vnode super table projection query
   * 2. keep the vgroup index for multi-vnode insertion
H
hjxilinx 已提交
77
   */
H
hjxilinx 已提交
78
  int32_t vgroupIndex;
H
hjxilinx 已提交
79
  char    name[TSDB_TABLE_ID_LEN];        // (super) table name
80
  SArray* tagColList;                     // SArray<SColumn*>, involved tag columns
H
hjxilinx 已提交
81
} STableMetaInfo;
H
hzcheng 已提交
82

S
slguan 已提交
83 84
/* the structure for sql function in select clause */
typedef struct SSqlExpr {
H
hjxilinx 已提交
85 86 87 88 89 90
  char      aliasName[TSDB_COL_NAME_LEN];  // as aliasName
  SColIndex colInfo;
  int64_t   uid;            // refactor use the pointer
  int16_t   functionId;     // function id in aAgg array
  int16_t   resType;        // return value type
  int16_t   resBytes;       // length of return value
91
  int16_t   interBytes;  // inter result buffer size
H
hjxilinx 已提交
92 93 94
  int16_t   numOfParams;    // argument value of each function
  tVariant  param[3];       // parameters are not more than 3
  int32_t   offset;         // sub result column value of arithmetic expression.
H
hzcheng 已提交
95 96
} SSqlExpr;

H
hjxilinx 已提交
97 98 99 100 101
typedef struct SColumnIndex {
  int16_t tableIndex;
  int16_t columnIndex;
} SColumnIndex;

H
hjxilinx 已提交
102 103
typedef struct SFieldSupInfo {
  bool            visible;
H
hjxilinx 已提交
104
  SExprInfo      *pArithExprInfo;
H
hjxilinx 已提交
105
  SSqlExpr *      pSqlExpr;
H
hjxilinx 已提交
106
} SFieldSupInfo;
S
slguan 已提交
107

H
hjxilinx 已提交
108
typedef struct SFieldInfo {
H
hjxilinx 已提交
109 110 111
  int16_t numOfOutput;   // number of column in result
  SArray *pFields;       // SArray<TAOS_FIELD>
  SArray *pSupportInfo;  // SArray<SFieldSupInfo>
H
hzcheng 已提交
112 113
} SFieldInfo;

114
typedef struct SColumn {
S
slguan 已提交
115 116 117
  SColumnIndex       colIndex;
  int32_t            numOfFilters;
  SColumnFilterInfo *filterInfo;
118
} SColumn;
H
hzcheng 已提交
119

S
slguan 已提交
120 121
typedef struct SCond {
  uint64_t uid;
H
hjxilinx 已提交
122
  int32_t  len;  // length of tag query condition data
H
hjxilinx 已提交
123
  char *   cond;
S
slguan 已提交
124 125 126
} SCond;

typedef struct SJoinNode {
S
slguan 已提交
127
  char     tableId[TSDB_TABLE_ID_LEN];
S
slguan 已提交
128 129 130 131 132 133 134 135 136 137
  uint64_t uid;
  int16_t  tagCol;
} SJoinNode;

typedef struct SJoinInfo {
  bool      hasJoin;
  SJoinNode left;
  SJoinNode right;
} SJoinInfo;

H
hzcheng 已提交
138
typedef struct STagCond {
S
slguan 已提交
139 140 141 142 143 144 145 146 147 148
  // relation between tbname list and query condition, including : TK_AND or TK_OR
  int16_t relType;

  // tbname query condition, only support tbname query condition on one table
  SCond tbnameCond;

  // join condition, only support two tables join currently
  SJoinInfo joinInfo;

  // for different table, the query condition must be seperated
H
hjxilinx 已提交
149
  SArray *pCond;
H
hzcheng 已提交
150 151
} STagCond;

S
slguan 已提交
152
typedef struct SParamInfo {
H
hjxilinx 已提交
153 154 155 156
  int32_t  idx;
  char     type;
  uint8_t  timePrec;
  short    bytes;
S
slguan 已提交
157 158 159
  uint32_t offset;
} SParamInfo;

S
slguan 已提交
160
typedef struct STableDataBlocks {
S
slguan 已提交
161
  char    tableId[TSDB_TABLE_ID_LEN];
162 163
  int8_t  tsSource;     // where does the UNIX timestamp come from, server or client
  bool    ordered;      // if current rows are ordered or not
H
hjxilinx 已提交
164
  int64_t vgId;         // virtual group id
165
  int64_t prevTS;       // previous timestamp, recorded to decide if the records array is ts ascending
S
slguan 已提交
166
  int32_t numOfTables;  // number of tables in current submit block
167 168

  int32_t  rowSize;  // row size for current table
S
slguan 已提交
169
  uint32_t nAllocSize;
H
hjxilinx 已提交
170
  uint32_t headerSize;  // header for metadata (submit metadata)
S
slguan 已提交
171
  uint32_t size;
172

H
hjxilinx 已提交
173 174 175 176
  /*
   * the metermeta for current table, the metermeta will be used during submit stage, keep a ref
   * to avoid it to be removed from cache
   */
H
hjxilinx 已提交
177
  STableMeta *pTableMeta;
178

H
hzcheng 已提交
179 180 181 182
  union {
    char *filename;
    char *pData;
  };
S
slguan 已提交
183 184

  // for parameter ('?') binding
H
hjxilinx 已提交
185 186 187
  uint32_t    numOfAllocedParams;
  uint32_t    numOfParams;
  SParamInfo *params;
S
slguan 已提交
188
} STableDataBlocks;
H
hzcheng 已提交
189

H
hjxilinx 已提交
190
typedef struct SDataBlockList {  // todo remove
H
hjxilinx 已提交
191 192
  uint32_t           nSize;
  uint32_t           nAlloc;
S
slguan 已提交
193
  STableDataBlocks **pData;
H
hzcheng 已提交
194 195
} SDataBlockList;

196
typedef struct SQueryInfo {
197
  int16_t  command;  // the command may be different for each subclause, so keep it seperately.
H
hjxilinx 已提交
198
  uint32_t type;     // query/insert/import type
H
hjxilinx 已提交
199
  char     slidingTimeUnit;
200

H
hjxilinx 已提交
201
  STimeWindow     window;
202
  int64_t         intervalTime;  // aggregation time interval
H
hjxilinx 已提交
203 204
  int64_t         slidingTime;   // sliding window in mseconds
  SSqlGroupbyExpr groupbyExpr;   // group by tags info
205

H
hjxilinx 已提交
206
  SArray *         colList;      // SArray<SColumn*>
207
  SFieldInfo       fieldsInfo;
H
hjxilinx 已提交
208
  SArray *         exprList;    // SArray<SSqlExpr*>
209 210 211 212
  SLimitVal        limit;
  SLimitVal        slimit;
  STagCond         tagCond;
  SOrderVal        order;
213
  int16_t          fillType;  // interpolate type
214
  int16_t          numOfTables;
H
hjxilinx 已提交
215
  STableMetaInfo **pTableMetaInfo;
216
  struct STSBuf *  tsBuf;
217 218
  int64_t *        defaultVal;   // default value for interpolation
  char *           msg;          // pointer to the pCmd->payload to keep error message temporarily
219
  int64_t          clauseLimit;  // limit for current sub clause
H
hjxilinx 已提交
220

221
  // offset value in the original sql expression, NOT sent to virtual node, only applied at client side
222
  int64_t          prjOffset;
223 224
} SQueryInfo;

H
hzcheng 已提交
225
typedef struct {
226 227
  int     command;
  uint8_t msgType;
S
slguan 已提交
228 229

  union {
230
    bool   existsCheck;     // check if the table exists or not
H
hjxilinx 已提交
231
    bool   autoCreated;     // if the table is missing, on-the-fly create it. during getmeterMeta
232
    int8_t dataSourceType;  // load data from file or not
S
slguan 已提交
233
  };
H
hjxilinx 已提交
234

235 236 237 238
  union {
    int32_t count;
    int32_t numOfTablesInSubmit;
  };
H
hzcheng 已提交
239

240 241 242 243 244 245
  int32_t      clauseIndex;  // index of multiple subclause query
  int8_t       parseFinished;
  short        numOfCols;
  uint32_t     allocSize;
  char *       payload;
  int32_t      payloadLen;
246 247
  SQueryInfo **pQueryInfo;
  int32_t      numOfClause;
H
hjxilinx 已提交
248 249 250 251 252

  SDataBlockList *pDataBlocks;  // submit data blocks after parsing sql
  char *          curSql;       // current sql, resume position of sql after parsing paused
  void *          pTableList;   // referred table involved in sql

S
slguan 已提交
253 254 255
  // for parameter ('?') binding and batch processing
  int32_t batchSize;
  int32_t numOfParams;
H
hzcheng 已提交
256 257 258 259 260 261 262 263
} SSqlCmd;

typedef struct SResRec {
  int numOfRows;
  int numOfTotal;
} SResRec;

typedef struct {
H
hjxilinx 已提交
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
  int64_t               numOfRows;                  // num of results in current retrieved
  int64_t               numOfTotal;                 // num of total results
  int64_t               numOfTotalInCurrentClause;  // num of total result in current subclause
  char *                pRsp;
  int32_t               rspType;
  int32_t               rspLen;
  uint64_t              qhandle;
  int64_t               uid;
  int64_t               useconds;
  int64_t               offset;  // offset value from vnode during projection query of stable
  int32_t               row;
  int16_t               numOfCols;
  int16_t               precision;
  bool                  completed;
  int32_t               code;
  int32_t               numOfGroups;
  SResRec *             pGroupRec;
  char *                data;
  void **               tsrow;
283
  int32_t*              length;  // length for each field for current row
H
hjxilinx 已提交
284 285
  char **               buffer;  // Buffer used to put multibytes encoded using unicode (wchar_t)
  SColumnIndex *        pColumnIndex;
286 287
  SArithmeticSupport*   pArithSup;   // support the arithmetic expression calculation on agg functions
  
H
hzcheng 已提交
288 289 290
  struct SLocalReducer *pLocalReducer;
} SSqlRes;

H
hjxilinx 已提交
291
typedef struct STscObj {
H
hjxilinx 已提交
292 293 294 295 296 297 298 299 300 301 302 303 304 305
  void *             signature;
  void *             pTimer;
  char               mgmtIp[TSDB_USER_LEN];
  uint16_t           mgmtPort;
  char               user[TSDB_USER_LEN];
  char               pass[TSDB_KEY_LEN];
  char               acctId[TSDB_DB_NAME_LEN];
  char               db[TSDB_TABLE_ID_LEN];
  char               sversion[TSDB_VERSION_LEN];
  char               writeAuth : 1;
  char               superAuth : 1;
  struct SSqlObj *   pSql;
  struct SSqlObj *   pHb;
  struct SSqlObj *   sqlList;
H
hjxilinx 已提交
306
  struct SSqlStream *streamList;
307
  void*              pDnodeConn;
H
hjxilinx 已提交
308
  pthread_mutex_t    mutex;
H
hzcheng 已提交
309 310
} STscObj;

311
typedef struct SSqlObj {
H
hzcheng 已提交
312 313 314 315
  void *   signature;
  STscObj *pTscObj;
  void (*fp)();
  void (*fetchFp)();
H
hjxilinx 已提交
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
  void *           param;
  int64_t          stime;
  uint32_t         queryId;
  void *           pStream;
  void *           pSubscription;
  char *           sqlstr;
  char             retry;
  char             maxRetry;
  SRpcIpSet        ipList;
  char             freed : 4;
  char             listed : 4;
  tsem_t           rspSem;
  SSqlCmd          cmd;
  SSqlRes          res;
  uint8_t          numOfSubs;
331 332
  struct SSqlObj **pSubs;
  struct SSqlObj * prev, *next;
H
hzcheng 已提交
333 334
} SSqlObj;

H
hjxilinx 已提交
335
typedef struct SSqlStream {
H
hzcheng 已提交
336 337 338 339 340 341
  SSqlObj *pSql;
  uint32_t streamId;
  char     listed;
  int64_t  num;  // number of computing count

  /*
S
slguan 已提交
342
   * keep the number of current result in computing,
H
hzcheng 已提交
343 344 345 346 347 348 349
   * the value will be set to 0 before set timer for next computing
   */
  int64_t numOfRes;

  int64_t useconds;  // total  elapsed time
  int64_t ctime;     // stream created time
  int64_t stime;     // stream next executed time
S
slguan 已提交
350
  int64_t etime;     // stream end query time, when time is larger then etime, the stream will be closed
H
hzcheng 已提交
351 352
  int64_t interval;
  int64_t slidingTime;
353
  int16_t precision;
H
hzcheng 已提交
354 355 356 357 358
  void *  pTimer;

  void (*fp)();
  void *param;

S
slguan 已提交
359
  void (*callback)(void *);  // Callback function when stream is stopped from client level
H
hjxilinx 已提交
360
  struct SSqlStream *prev, *next;
H
hzcheng 已提交
361 362
} SSqlStream;

363
int32_t tscInitRpc(const char *user, const char *secret, void** pDnodeConn);
H
hjxilinx 已提交
364
void    tscInitMsgsFp();
S
slguan 已提交
365

366
int tsParseSql(SSqlObj *pSql, bool multiVnodeInsertion);
H
hzcheng 已提交
367

J
jtao1735 已提交
368
void tscProcessMsgFromServer(SRpcMsg *rpcMsg, SRpcIpSet *pIpSet);
S
slguan 已提交
369
int  tscProcessSql(SSqlObj *pSql);
H
hzcheng 已提交
370

S
slguan 已提交
371
int  tscRenewMeterMeta(SSqlObj *pSql, char *tableId);
H
hzcheng 已提交
372
void tscQueueAsyncRes(SSqlObj *pSql);
S
slguan 已提交
373

H
[td-99]  
hjxilinx 已提交
374
void tscQueueAsyncError(void(*fp), void *param, int32_t code);
H
hzcheng 已提交
375 376 377 378 379

int tscProcessLocalCmd(SSqlObj *pSql);
int tscCfgDynamicOptions(char *msg);
int taos_retrieve(TAOS_RES *res);

H
hjxilinx 已提交
380 381
int32_t tscTansformSQLFuncForSTableQuery(SQueryInfo *pQueryInfo);
void    tscRestoreSQLFuncForSTableQuery(SQueryInfo *pQueryInfo);
H
hzcheng 已提交
382

383
int32_t tscCreateResPointerInfo(SSqlRes *pRes, SQueryInfo *pQueryInfo);
H
hjxilinx 已提交
384
void    tscDestroyResPointerInfo(SSqlRes *pRes);
H
hzcheng 已提交
385

386
void tscResetSqlCmdObj(SSqlCmd *pCmd);
H
hzcheng 已提交
387

weixin_48148422's avatar
weixin_48148422 已提交
388 389 390 391
/**
 * free query result of the sql object
 * @param pObj
 */
H
hjxilinx 已提交
392
void tscFreeSqlResult(SSqlObj *pSql);
weixin_48148422's avatar
weixin_48148422 已提交
393

H
hzcheng 已提交
394 395 396 397 398
/**
 * only free part of resources allocated during query.
 * Note: this function is multi-thread safe.
 * @param pObj
 */
H
hjxilinx 已提交
399
void tscPartiallyFreeSqlObj(SSqlObj *pObj);
H
hzcheng 已提交
400 401 402 403 404 405 406 407 408 409

/**
 * free sql object, release allocated resource
 * @param pObj  Free metric/meta information, dynamically allocated payload, and
 * response buffer, object itself
 */
void tscFreeSqlObj(SSqlObj *pObj);

void tscCloseTscObj(STscObj *pObj);

H
hjxilinx 已提交
410 411 412 413
TAOS *taos_connect_a(char *ip, char *user, char *pass, char *db, uint16_t port, void (*fp)(void *, TAOS_RES *, int),
                     void *param, void **taos);

void doAsyncQuery(STscObj *pObj, SSqlObj *pSql, void (*fp)(), void *param, const char *sqlstr, size_t sqlLen);
414

415
void tscProcessMultiVnodesInsertFromFile(SSqlObj *pSql);
H
hjxilinx 已提交
416
void tscKillSTableQuery(SSqlObj *pSql);
417 418
void tscInitResObjForLocalQuery(SSqlObj *pObj, int32_t numOfRes, int32_t rowLen);
bool tscIsUpdateQuery(STscObj *pObj);
419
bool tscHasReachLimitation(SQueryInfo *pQueryInfo, SSqlRes *pRes);
H
hjxilinx 已提交
420

421
char *tscGetErrorMsgPayload(SSqlCmd *pCmd);
422

H
hjxilinx 已提交
423
int32_t tscInvalidSQLErrMsg(char *msg, const char *additionalInfo, const char *sql);
H
hzcheng 已提交
424

H
hjxilinx 已提交
425 426
void    tscQueueAsyncFreeResult(SSqlObj *pSql);
int32_t tscToSQLCmd(SSqlObj *pSql, struct SSqlInfo *pInfo);
427
void    tscGetResultColumnChr(SSqlRes *pRes, SFieldInfo* pFieldInfo, int32_t column);
H
hjxilinx 已提交
428 429 430 431 432 433 434 435 436 437

extern void *    tscCacheHandle;
extern void *    tscTmr;
extern void *    tscQhandle;
extern int       tscKeepConn[];
extern int       tsInsertHeadSize;
extern int       tscNumOfThreads;
extern SRpcIpSet tscMgmtIpSet;

extern int (*tscBuildMsg[TSDB_SQL_MAX])(SSqlObj *pSql, SSqlInfo *pInfo);
H
hzcheng 已提交
438

439 440
typedef void (*__async_cb_func_t)(void *param, TAOS_RES *tres, int numOfRows);

weixin_48148422's avatar
weixin_48148422 已提交
441 442 443
int32_t tscCompareTidTags(const void* p1, const void* p2);
void tscBuildVgroupTableInfo(STableMetaInfo* pTableMetaInfo, SArray* tables);

H
hzcheng 已提交
444 445 446 447 448
#ifdef __cplusplus
}
#endif

#endif