tsclient.h 14.3 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

25 26 27
#include "qsqlparser.h"
#include "qsqltype.h"
#include "qtsbuf.h"
H
hzcheng 已提交
28
#include "taos.h"
29
#include "taosdef.h"
H
hzcheng 已提交
30 31 32
#include "taosmsg.h"
#include "tglobalcfg.h"
#include "tlog.h"
33
#include "trpc.h"
H
hzcheng 已提交
34 35
#include "tsqlfunction.h"
#include "tutil.h"
36
#include "tarray.h"
H
hzcheng 已提交
37

H
hjxilinx 已提交
38 39
#define TSC_GET_RESPTR_BASE(res, _queryinfo, col) (res->data + ((_queryinfo)->fieldsInfo.pSqlExpr[col]->offset) * res->numOfRows)

H
hzcheng 已提交
40 41 42 43
// forward declaration
struct SSqlInfo;

typedef struct SSqlGroupbyExpr {
H
hjxilinx 已提交
44
  int16_t     tableIndex;
S
slguan 已提交
45 46
  int16_t     numOfGroupCols;
  SColIndexEx columnInfo[TSDB_MAX_TAGS];  // group by columns information
H
hjxilinx 已提交
47 48
  int16_t     orderIndex;                 // order by column index
  int16_t     orderType;                  // order by type: asc/desc
S
slguan 已提交
49
} SSqlGroupbyExpr;
H
hzcheng 已提交
50

H
hjxilinx 已提交
51
typedef struct STableComInfo {
H
hjxilinx 已提交
52 53 54 55
  uint8_t numOfTags;
  uint8_t precision;
  int16_t numOfColumns;
  int16_t rowSize;
H
hjxilinx 已提交
56
} STableComInfo;
H
hjxilinx 已提交
57 58

typedef struct STableMeta {
H
hjxilinx 已提交
59 60 61 62 63
  //super table if it is created according to super table, otherwise, tableInfo is used
  union { struct STableMeta* pSTable; STableComInfo tableInfo; };
  uint8_t    tableType;
  int8_t     numOfVpeers;
  int16_t    sversion;
H
hjxilinx 已提交
64
  SVnodeDesc vpeerDesc[TSDB_VNODES_SUPPORT];
H
hjxilinx 已提交
65 66 67 68
  int32_t    vgid;     // virtual group id, which current table belongs to
  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 已提交
69 70 71
} STableMeta;

typedef struct STableMetaInfo {
H
hjxilinx 已提交
72
  STableMeta * pTableMeta;       // table meta, cached in client side and acquried by name
S
slguan 已提交
73
  SSuperTableMeta *pMetricMeta;  // metricmeta
74

H
hjxilinx 已提交
75 76 77 78
  /*
   * 1. keep the vnode index during the multi-vnode super table projection query
   * 2. keep the vnode index for multi-vnode insertion
   */
79
  int32_t vnodeIndex;
H
hjxilinx 已提交
80
  char    name[TSDB_TABLE_ID_LEN];        // (super) table name
81 82
  int16_t numOfTags;                      // total required tags in query, including groupby tags
  int16_t tagColumnIndex[TSDB_MAX_TAGS];  // clause + tag projection
H
hjxilinx 已提交
83
} STableMetaInfo;
H
hzcheng 已提交
84

S
slguan 已提交
85 86
/* the structure for sql function in select clause */
typedef struct SSqlExpr {
87
  char        aliasName[TSDB_COL_NAME_LEN];  // as aliasName
S
slguan 已提交
88 89 90 91 92 93 94 95
  SColIndexEx 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
  int16_t     interResBytes;  // inter result buffer size
  int16_t     numOfParams;    // argument value of each function
  tVariant    param[3];       // parameters are not more than 3
H
hjxilinx 已提交
96
  int32_t     offset;         // sub result column value of arithmetic expression.
H
hzcheng 已提交
97 98
} SSqlExpr;

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

H
hzcheng 已提交
104 105 106 107
typedef struct SFieldInfo {
  int16_t     numOfOutputCols;  // number of column in result
  int16_t     numOfAlloc;       // allocated size
  TAOS_FIELD *pFields;
S
slguan 已提交
108 109 110 111 112 113 114 115

  /*
   * define if this column is belong to the queried result, it may be add by parser to faciliate
   * the query process
   *
   * NOTE: these hidden columns always locate at the end of the output columns
   */
  bool *  pVisibleCols;
H
hjxilinx 已提交
116 117 118
  int32_t numOfHiddenCols;   // the number of column not belongs to the queried result columns
  SSqlFunctionExpr** pExpr;  // used for aggregation arithmetic express,such as count(*)+count(*)
  SSqlExpr** pSqlExpr;
H
hzcheng 已提交
119 120 121
} SFieldInfo;

typedef struct SSqlExprInfo {
H
hjxilinx 已提交
122 123 124
  int16_t    numOfAlloc;
  int16_t    numOfExprs;
  SSqlExpr** pExprs;
H
hzcheng 已提交
125 126
} SSqlExprInfo;

S
slguan 已提交
127 128 129 130
typedef struct SColumnBase {
  SColumnIndex       colIndex;
  int32_t            numOfFilters;
  SColumnFilterInfo *filterInfo;
H
hzcheng 已提交
131 132
} SColumnBase;

S
slguan 已提交
133
typedef struct SColumnBaseInfo {
H
hzcheng 已提交
134 135 136
  int16_t      numOfAlloc;
  int16_t      numOfCols;
  SColumnBase *pColList;
S
slguan 已提交
137
} SColumnBaseInfo;
H
hzcheng 已提交
138 139 140

struct SLocalReducer;

S
slguan 已提交
141 142
typedef struct SCond {
  uint64_t uid;
H
hjxilinx 已提交
143
  char *   cond;
S
slguan 已提交
144 145 146
} SCond;

typedef struct SJoinNode {
S
slguan 已提交
147
  char     tableId[TSDB_TABLE_ID_LEN];
S
slguan 已提交
148 149 150 151 152 153 154 155 156 157
  uint64_t uid;
  int16_t  tagCol;
} SJoinNode;

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

H
hzcheng 已提交
158
typedef struct STagCond {
S
slguan 已提交
159 160 161 162 163 164 165 166 167 168 169 170
  // 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
  SCond   cond[TSDB_MAX_JOIN_TABLE_NUM];
  int16_t numOfTagCond;
H
hzcheng 已提交
171 172
} STagCond;

S
slguan 已提交
173
typedef struct SParamInfo {
H
hjxilinx 已提交
174 175 176 177
  int32_t  idx;
  char     type;
  uint8_t  timePrec;
  short    bytes;
S
slguan 已提交
178 179 180
  uint32_t offset;
} SParamInfo;

S
slguan 已提交
181
typedef struct STableDataBlocks {
S
slguan 已提交
182
  char    tableId[TSDB_TABLE_ID_LEN];
183 184 185 186
  int8_t  tsSource;     // where does the UNIX timestamp come from, server or client
  bool    ordered;      // if current rows are ordered or not
  int64_t vgid;         // virtual group id
  int64_t prevTS;       // previous timestamp, recorded to decide if the records array is ts ascending
S
slguan 已提交
187
  int32_t numOfTables;  // number of tables in current submit block
188 189

  int32_t  rowSize;  // row size for current table
S
slguan 已提交
190
  uint32_t nAllocSize;
H
hjxilinx 已提交
191
  uint32_t headerSize;  // header for metadata (submit metadata)
S
slguan 已提交
192
  uint32_t size;
193

H
hjxilinx 已提交
194 195 196 197
  /*
   * 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 已提交
198
  STableMeta *pTableMeta;
199

H
hzcheng 已提交
200 201 202 203
  union {
    char *filename;
    char *pData;
  };
S
slguan 已提交
204 205

  // for parameter ('?') binding
H
hjxilinx 已提交
206 207 208
  uint32_t    numOfAllocedParams;
  uint32_t    numOfParams;
  SParamInfo *params;
S
slguan 已提交
209
} STableDataBlocks;
H
hzcheng 已提交
210 211

typedef struct SDataBlockList {
S
slguan 已提交
212
  int32_t            idx;
H
hjxilinx 已提交
213 214
  uint32_t           nSize;
  uint32_t           nAlloc;
S
slguan 已提交
215 216
  char *             userParam; /* user assigned parameters for async query */
  void *             udfp;      /* user defined function pointer, used in async model */
S
slguan 已提交
217
  STableDataBlocks **pData;
H
hzcheng 已提交
218 219
} SDataBlockList;

220
typedef struct SQueryInfo {
221 222
  int16_t  command;  // the command may be different for each subclause, so keep it seperately.
  uint16_t type;     // query/insert/import type
H
hjxilinx 已提交
223
  char     slidingTimeUnit;
224

225
  int64_t         etime, stime;
226
  int64_t         intervalTime;  // aggregation time interval
H
hjxilinx 已提交
227 228
  int64_t         slidingTime;   // sliding window in mseconds
  SSqlGroupbyExpr groupbyExpr;   // group by tags info
229 230 231 232 233 234 235 236 237 238

  SColumnBaseInfo  colList;
  SFieldInfo       fieldsInfo;
  SSqlExprInfo     exprsInfo;
  SLimitVal        limit;
  SLimitVal        slimit;
  STagCond         tagCond;
  SOrderVal        order;
  int16_t          interpoType;  // interpolate type
  int16_t          numOfTables;
H
hjxilinx 已提交
239
  STableMetaInfo **pTableMetaInfo;
240
  struct STSBuf *  tsBuf;
241 242
  int64_t *        defaultVal;   // default value for interpolation
  char *           msg;          // pointer to the pCmd->payload to keep error message temporarily
243
  int64_t          clauseLimit;  // limit for current sub clause
H
hjxilinx 已提交
244

245
  // offset value in the original sql expression, NOT sent to virtual node, only applied at client side
H
hjxilinx 已提交
246
  int64_t prjOffset;
247 248
} SQueryInfo;

249 250 251 252 253 254
// data source from sql string or from file
enum {
  DATA_FROM_SQL_STRING = 1,
  DATA_FROM_DATA_FILE = 2,
};

H
hzcheng 已提交
255
typedef struct {
256 257
  int     command;
  uint8_t msgType;
S
slguan 已提交
258 259

  union {
260 261
    bool   existsCheck;     // check if the table exists or not
    bool   inStream;        // denote if current sql is executed in stream or not
H
hjxilinx 已提交
262
    bool   autoCreated;  // if the table is missing, on-the-fly create it. during getmeterMeta
263
    int8_t dataSourceType;  // load data from file or not
S
slguan 已提交
264
  };
H
hjxilinx 已提交
265

266 267 268 269
  union {
    int32_t count;
    int32_t numOfTablesInSubmit;
  };
H
hzcheng 已提交
270

271 272 273 274 275 276 277
  int32_t  clauseIndex;  // index of multiple subclause query
  int8_t   isParseFinish;
  short    numOfCols;
  uint32_t allocSize;
  char *   payload;
  int      payloadLen;

278 279
  SQueryInfo **pQueryInfo;
  int32_t      numOfClause;
H
hzcheng 已提交
280

S
slguan 已提交
281
  // submit data blocks branched according to vnode
282
  SDataBlockList *pDataBlocks;
S
slguan 已提交
283 284 285 286

  // for parameter ('?') binding and batch processing
  int32_t batchSize;
  int32_t numOfParams;
H
hzcheng 已提交
287 288 289 290 291 292 293
} SSqlCmd;

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

S
slguan 已提交
294 295
struct STSBuf;

H
hzcheng 已提交
296
typedef struct {
S
slguan 已提交
297
  int32_t       code;
H
hjxilinx 已提交
298 299 300 301 302 303 304 305 306 307 308
  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;
  int           rspType;
  int           rspLen;
  uint64_t      qhandle;
  int64_t       uid;
  int64_t       useconds;
  int64_t       offset;  // offset value from vnode during projection query of stable
  int           row;
H
hjxilinx 已提交
309
  int16_t       numOfCols;
H
hjxilinx 已提交
310 311 312 313 314 315 316
  int16_t       precision;
  int32_t       numOfGroups;
  SResRec *     pGroupRec;
  char *        data;
  void **       tsrow;
  char **       buffer;  // Buffer used to put multibytes encoded using unicode (wchar_t)
  SColumnIndex *pColumnIndex;
H
hzcheng 已提交
317 318 319
  struct SLocalReducer *pLocalReducer;
} SSqlRes;

H
hjxilinx 已提交
320
typedef struct STscObj {
H
hzcheng 已提交
321 322 323
  void *           signature;
  void *           pTimer;
  char             mgmtIp[TSDB_USER_LEN];
L
lihui 已提交
324
  uint16_t         mgmtPort;
H
hzcheng 已提交
325 326 327
  char             user[TSDB_USER_LEN];
  char             pass[TSDB_KEY_LEN];
  char             acctId[TSDB_DB_NAME_LEN];
S
slguan 已提交
328
  char             db[TSDB_TABLE_ID_LEN];
H
hzcheng 已提交
329 330 331
  char             sversion[TSDB_VERSION_LEN];
  char             writeAuth : 1;
  char             superAuth : 1;
332 333 334
  struct SSqlObj *pSql;
  struct SSqlObj *pHb;
  struct SSqlObj *sqlList;
H
hjxilinx 已提交
335
  struct SSqlStream *streamList;
H
hzcheng 已提交
336 337 338
  pthread_mutex_t  mutex;
} STscObj;

339
typedef struct SSqlObj {
H
hzcheng 已提交
340 341 342 343
  void *   signature;
  STscObj *pTscObj;
  void (*fp)();
  void (*fetchFp)();
H
hjxilinx 已提交
344 345 346 347 348 349
  void *            param;
  uint32_t          ip;
  short             vnode;
  int64_t           stime;
  uint32_t          queryId;
  void *            pStream;
weixin_48148422's avatar
weixin_48148422 已提交
350
  void *            pSubscription;
H
hjxilinx 已提交
351 352 353
  char *            sqlstr;
  char              retry;
  char              maxRetry;
S
slguan 已提交
354
  SRpcIpSet        *ipList;
H
hjxilinx 已提交
355 356 357 358 359 360
  char              freed : 4;
  char              listed : 4;
  tsem_t            rspSem;
  tsem_t            emptyRspSem;
  SSqlCmd           cmd;
  SSqlRes           res;
H
hjxilinx 已提交
361
  uint8_t           numOfSubs;
362 363
  char *            asyncTblPos;
  void *            pTableHashList;
364 365
  struct SSqlObj **pSubs;
  struct SSqlObj * prev, *next;
H
hzcheng 已提交
366 367
} SSqlObj;

H
hjxilinx 已提交
368
typedef struct SSqlStream {
H
hzcheng 已提交
369 370 371 372 373 374
  SSqlObj *pSql;
  uint32_t streamId;
  char     listed;
  int64_t  num;  // number of computing count

  /*
S
slguan 已提交
375
   * keep the number of current result in computing,
H
hzcheng 已提交
376 377 378 379 380 381 382
   * 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 已提交
383
  int64_t etime;     // stream end query time, when time is larger then etime, the stream will be closed
H
hzcheng 已提交
384 385
  int64_t interval;
  int64_t slidingTime;
386
  int16_t precision;
H
hzcheng 已提交
387 388 389 390 391
  void *  pTimer;

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

S
slguan 已提交
392
  void (*callback)(void *);  // Callback function when stream is stopped from client level
H
hjxilinx 已提交
393
  struct SSqlStream *prev, *next;
H
hzcheng 已提交
394 395
} SSqlStream;

S
slguan 已提交
396 397
int32_t tscInitRpc(const char *user, const char *secret);

H
hzcheng 已提交
398
// tscSql API
399
int tsParseSql(SSqlObj *pSql, bool multiVnodeInsertion);
H
hzcheng 已提交
400

401
void tscInitMsgsFp();
402 403
extern int (*tscBuildMsg[TSDB_SQL_MAX])(SSqlObj *pSql, SSqlInfo *pInfo);

404
void tscProcessMsgFromServer(SRpcMsg *rpcMsg);
S
slguan 已提交
405
int  tscProcessSql(SSqlObj *pSql);
H
hzcheng 已提交
406

S
slguan 已提交
407
int  tscRenewMeterMeta(SSqlObj *pSql, char *tableId);
H
hzcheng 已提交
408
void tscQueueAsyncRes(SSqlObj *pSql);
S
slguan 已提交
409

H
hzcheng 已提交
410 411 412 413 414 415 416 417 418 419
void tscQueueAsyncError(void(*fp), void *param);

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

/*
 * transfer function for metric query in stream computing, the function need to be change
 * before send query message to vnode
 */
420 421
int32_t tscTansformSQLFunctionForSTableQuery(SQueryInfo *pQueryInfo);
void    tscRestoreSQLFunctionForMetricQuery(SQueryInfo *pQueryInfo);
H
hzcheng 已提交
422

423
int32_t tscCreateResPointerInfo(SSqlRes *pRes, SQueryInfo *pQueryInfo);
H
hjxilinx 已提交
424
void    tscDestroyResPointerInfo(SSqlRes *pRes);
H
hzcheng 已提交
425

S
slguan 已提交
426
void tscFreeSqlCmdData(SSqlCmd *pCmd);
H
hjxilinx 已提交
427
void tscFreeResData(SSqlObj *pSql);
H
hzcheng 已提交
428

weixin_48148422's avatar
weixin_48148422 已提交
429 430 431 432
/**
 * free query result of the sql object
 * @param pObj
 */
H
hjxilinx 已提交
433
void tscFreeSqlResult(SSqlObj *pSql);
weixin_48148422's avatar
weixin_48148422 已提交
434

H
hzcheng 已提交
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
/**
 * only free part of resources allocated during query.
 * Note: this function is multi-thread safe.
 * @param pObj
 */
void tscFreeSqlObjPartial(SSqlObj *pObj);

/**
 * 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);

451 452
void doAsyncQuery(STscObj* pObj, SSqlObj* pSql, void (*fp)(), void* param, const char* sqlstr, int32_t sqlLen);

453 454 455 456 457
void tscProcessMultiVnodesInsert(SSqlObj *pSql);
void tscProcessMultiVnodesInsertFromFile(SSqlObj *pSql);
void tscKillMetricQuery(SSqlObj *pSql);
void tscInitResObjForLocalQuery(SSqlObj *pObj, int32_t numOfRes, int32_t rowLen);
bool tscIsUpdateQuery(STscObj *pObj);
458
bool tscHasReachLimitation(SQueryInfo *pQueryInfo, SSqlRes *pRes);
H
hjxilinx 已提交
459

460
char *tscGetErrorMsgPayload(SSqlCmd *pCmd);
461

H
hjxilinx 已提交
462
int32_t tscInvalidSQLErrMsg(char *msg, const char *additionalInfo, const char *sql);
H
hzcheng 已提交
463 464

void tscQueueAsyncFreeResult(SSqlObj *pSql);
H
hjxilinx 已提交
465
int32_t tscToSQLCmd(SSqlObj* pSql, struct SSqlInfo* pInfo);
H
hzcheng 已提交
466

S
slguan 已提交
467 468 469
extern void *     pVnodeConn;
extern void *     pTscMgmtConn;
extern void *     tscCacheHandle;
470
extern int32_t    globalCode;
S
slguan 已提交
471 472 473 474 475 476
extern int        slaveIndex;
extern void *     tscTmr;
extern void *     tscQhandle;
extern int        tscKeepConn[];
extern int        tsInsertHeadSize;
extern int        tscNumOfThreads;
S
slguan 已提交
477
extern SRpcIpSet  tscMgmtIpList;
H
hzcheng 已提交
478

479 480
typedef void (*__async_cb_func_t)(void *param, TAOS_RES *tres, int numOfRows);

H
hzcheng 已提交
481 482 483 484 485
#ifdef __cplusplus
}
#endif

#endif