tsclient.h 13.6 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"
H
hzcheng 已提交
24 25 26 27 28
#include "taos.h"
#include "taosmsg.h"
#include "tglobalcfg.h"
#include "tlog.h"
#include "tscCache.h"
S
slguan 已提交
29
#include "taosdef.h"
H
hzcheng 已提交
30 31
#include "tsqlfunction.h"
#include "tutil.h"
S
slguan 已提交
32
#include "trpc.h"
33
#include "qsqltype.h"
34
#include "qsqlparser.h"
H
hzcheng 已提交
35

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

H
hzcheng 已提交
38 39 40 41
// forward declaration
struct SSqlInfo;

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

S
slguan 已提交
49
typedef struct SMeterMetaInfo {
S
slguan 已提交
50 51
  STableMeta * pMeterMeta;   // metermeta
  SSuperTableMeta *pMetricMeta;  // metricmeta
52

H
hjxilinx 已提交
53 54 55 56
  /*
   * 1. keep the vnode index during the multi-vnode super table projection query
   * 2. keep the vnode index for multi-vnode insertion
   */
57
  int32_t vnodeIndex;
S
slguan 已提交
58
  char    name[TSDB_TABLE_ID_LEN + 1];    // table(super table) name
59 60
  int16_t numOfTags;                      // total required tags in query, including groupby tags
  int16_t tagColumnIndex[TSDB_MAX_TAGS];  // clause + tag projection
S
slguan 已提交
61
} SMeterMetaInfo;
H
hzcheng 已提交
62

S
slguan 已提交
63 64 65 66 67 68 69 70 71 72 73
/* the structure for sql function in select clause */
typedef struct SSqlExpr {
  char        aliasName[TSDB_COL_NAME_LEN + 1];  // as aliasName
  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 已提交
74
  int32_t     offset;         // sub result column value of arithmetic expression.
H
hzcheng 已提交
75 76
} SSqlExpr;

H
hjxilinx 已提交
77 78 79 80 81
typedef struct SColumnIndex {
  int16_t tableIndex;
  int16_t columnIndex;
} SColumnIndex;

H
hzcheng 已提交
82 83 84 85
typedef struct SFieldInfo {
  int16_t     numOfOutputCols;  // number of column in result
  int16_t     numOfAlloc;       // allocated size
  TAOS_FIELD *pFields;
H
hjxilinx 已提交
86
//  short *     pOffset;
S
slguan 已提交
87 88 89 90 91 92 93 94

  /*
   * 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 已提交
95 96 97
  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 已提交
98 99 100
} SFieldInfo;

typedef struct SSqlExprInfo {
H
hjxilinx 已提交
101 102 103
  int16_t    numOfAlloc;
  int16_t    numOfExprs;
  SSqlExpr** pExprs;
H
hzcheng 已提交
104 105
} SSqlExprInfo;

S
slguan 已提交
106 107 108 109
typedef struct SColumnBase {
  SColumnIndex       colIndex;
  int32_t            numOfFilters;
  SColumnFilterInfo *filterInfo;
H
hzcheng 已提交
110 111
} SColumnBase;

S
slguan 已提交
112
typedef struct SColumnBaseInfo {
H
hzcheng 已提交
113 114 115
  int16_t      numOfAlloc;
  int16_t      numOfCols;
  SColumnBase *pColList;
S
slguan 已提交
116
} SColumnBaseInfo;
H
hzcheng 已提交
117 118 119

struct SLocalReducer;

S
slguan 已提交
120 121
typedef struct SCond {
  uint64_t uid;
H
hjxilinx 已提交
122
  char *   cond;
S
slguan 已提交
123 124 125
} SCond;

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

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

H
hzcheng 已提交
137
typedef struct STagCond {
S
slguan 已提交
138 139 140 141 142 143 144 145 146 147 148 149
  // 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 已提交
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 164 165
  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 已提交
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
   */
S
slguan 已提交
177
  STableMeta *pMeterMeta;
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 190

typedef struct SDataBlockList {
S
slguan 已提交
191
  int32_t            idx;
H
hjxilinx 已提交
192 193
  uint32_t           nSize;
  uint32_t           nAlloc;
S
slguan 已提交
194 195
  char *             userParam; /* user assigned parameters for async query */
  void *             udfp;      /* user defined function pointer, used in async model */
S
slguan 已提交
196
  STableDataBlocks **pData;
H
hzcheng 已提交
197 198
} SDataBlockList;

199
typedef struct SQueryInfo {
200 201 202 203
  int16_t  command;  // the command may be different for each subclause, so keep it seperately.
  uint16_t type;     // query/insert/import type
  char     intervalTimeUnit;

204
  int64_t         etime, stime;
205
  int64_t         intervalTime;  // aggregation time interval
H
hjxilinx 已提交
206 207
  int64_t         slidingTime;   // sliding window in mseconds
  SSqlGroupbyExpr groupbyExpr;   // group by tags info
208 209 210 211 212 213 214 215 216 217

  SColumnBaseInfo  colList;
  SFieldInfo       fieldsInfo;
  SSqlExprInfo     exprsInfo;
  SLimitVal        limit;
  SLimitVal        slimit;
  STagCond         tagCond;
  SOrderVal        order;
  int16_t          interpoType;  // interpolate type
  int16_t          numOfTables;
218 219
  SMeterMetaInfo **pMeterInfo;
  struct STSBuf *  tsBuf;
220 221
  int64_t *        defaultVal;   // default value for interpolation
  char *           msg;          // pointer to the pCmd->payload to keep error message temporarily
222
  int64_t          clauseLimit;  // limit for current sub clause
H
hjxilinx 已提交
223

224
  // offset value in the original sql expression, NOT sent to virtual node, only applied at client side
H
hjxilinx 已提交
225
  int64_t prjOffset;
226 227
} SQueryInfo;

228 229 230 231 232 233
// data source from sql string or from file
enum {
  DATA_FROM_SQL_STRING = 1,
  DATA_FROM_DATA_FILE = 2,
};

H
hzcheng 已提交
234
typedef struct {
235 236
  int     command;
  uint8_t msgType;
S
slguan 已提交
237 238

  union {
239 240 241 242
    bool   existsCheck;     // check if the table exists or not
    bool   inStream;        // denote if current sql is executed in stream or not
    bool   createOnDemand;  // if the table is missing, on-the-fly create it. during getmeterMeta
    int8_t dataSourceType;  // load data from file or not
S
slguan 已提交
243
  };
H
hjxilinx 已提交
244

245 246 247 248
  union {
    int32_t count;
    int32_t numOfTablesInSubmit;
  };
H
hzcheng 已提交
249

250 251 252 253 254 255 256
  int32_t  clauseIndex;  // index of multiple subclause query
  int8_t   isParseFinish;
  short    numOfCols;
  uint32_t allocSize;
  char *   payload;
  int      payloadLen;

257 258
  SQueryInfo **pQueryInfo;
  int32_t      numOfClause;
H
hzcheng 已提交
259

S
slguan 已提交
260
  // submit data blocks branched according to vnode
261
  SDataBlockList *pDataBlocks;
S
slguan 已提交
262 263 264 265

  // for parameter ('?') binding and batch processing
  int32_t batchSize;
  int32_t numOfParams;
H
hzcheng 已提交
266 267 268 269 270 271 272
} SSqlCmd;

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

S
slguan 已提交
273 274
struct STSBuf;

H
hzcheng 已提交
275
typedef struct {
S
slguan 已提交
276
  int32_t       code;
H
hjxilinx 已提交
277 278 279 280 281 282 283 284 285 286 287
  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 已提交
288
  int16_t       numOfCols;
H
hjxilinx 已提交
289 290 291 292 293 294 295
  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 已提交
296 297 298 299 300 301 302
  struct SLocalReducer *pLocalReducer;
} SSqlRes;

typedef struct _tsc_obj {
  void *           signature;
  void *           pTimer;
  char             mgmtIp[TSDB_USER_LEN];
L
lihui 已提交
303
  uint16_t         mgmtPort;
H
hzcheng 已提交
304 305 306
  char             user[TSDB_USER_LEN];
  char             pass[TSDB_KEY_LEN];
  char             acctId[TSDB_DB_NAME_LEN];
S
slguan 已提交
307
  char             db[TSDB_TABLE_ID_LEN];
H
hzcheng 已提交
308 309 310
  char             sversion[TSDB_VERSION_LEN];
  char             writeAuth : 1;
  char             superAuth : 1;
311 312 313
  struct SSqlObj *pSql;
  struct SSqlObj *pHb;
  struct SSqlObj *sqlList;
H
hzcheng 已提交
314 315 316 317
  struct _sstream *streamList;
  pthread_mutex_t  mutex;
} STscObj;

318
typedef struct SSqlObj {
H
hzcheng 已提交
319 320 321 322
  void *   signature;
  STscObj *pTscObj;
  void (*fp)();
  void (*fetchFp)();
H
hjxilinx 已提交
323 324 325 326 327 328
  void *            param;
  uint32_t          ip;
  short             vnode;
  int64_t           stime;
  uint32_t          queryId;
  void *            pStream;
weixin_48148422's avatar
weixin_48148422 已提交
329
  void *            pSubscription;
H
hjxilinx 已提交
330 331 332
  char *            sqlstr;
  char              retry;
  char              maxRetry;
S
slguan 已提交
333
  SRpcIpSet        *ipList;
H
hjxilinx 已提交
334 335 336 337 338 339
  char              freed : 4;
  char              listed : 4;
  tsem_t            rspSem;
  tsem_t            emptyRspSem;
  SSqlCmd           cmd;
  SSqlRes           res;
H
hjxilinx 已提交
340
  uint8_t           numOfSubs;
341 342
  char *            asyncTblPos;
  void *            pTableHashList;
343 344
  struct SSqlObj **pSubs;
  struct SSqlObj * prev, *next;
H
hzcheng 已提交
345 346 347 348 349 350 351 352 353
} SSqlObj;

typedef struct _sstream {
  SSqlObj *pSql;
  uint32_t streamId;
  char     listed;
  int64_t  num;  // number of computing count

  /*
S
slguan 已提交
354
   * keep the number of current result in computing,
H
hzcheng 已提交
355 356 357 358 359 360 361
   * 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 已提交
362
  int64_t etime;     // stream end query time, when time is larger then etime, the stream will be closed
H
hzcheng 已提交
363 364
  int64_t interval;
  int64_t slidingTime;
365
  int16_t precision;
H
hzcheng 已提交
366 367 368 369 370
  void *  pTimer;

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

S
slguan 已提交
371
  void (*callback)(void *);  // Callback function when stream is stopped from client level
H
hzcheng 已提交
372 373 374
  struct _sstream *prev, *next;
} SSqlStream;

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

H
hzcheng 已提交
377
// tscSql API
378
int tsParseSql(SSqlObj *pSql, bool multiVnodeInsertion);
H
hzcheng 已提交
379

380
void tscInitMsgs();
381 382
extern int (*tscBuildMsg[TSDB_SQL_MAX])(SSqlObj *pSql, SSqlInfo *pInfo);

383
void tscProcessMsgFromServer(SRpcMsg *rpcMsg);
S
slguan 已提交
384
int  tscProcessSql(SSqlObj *pSql);
H
hzcheng 已提交
385 386 387

void tscAsyncInsertMultiVnodesProxy(void *param, TAOS_RES *tres, int numOfRows);

S
slguan 已提交
388
int  tscRenewMeterMeta(SSqlObj *pSql, char *tableId);
H
hzcheng 已提交
389
void tscQueueAsyncRes(SSqlObj *pSql);
S
slguan 已提交
390

H
hzcheng 已提交
391 392 393 394 395 396 397 398 399 400
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
 */
401 402
int32_t tscTansformSQLFunctionForSTableQuery(SQueryInfo *pQueryInfo);
void    tscRestoreSQLFunctionForMetricQuery(SQueryInfo *pQueryInfo);
H
hzcheng 已提交
403

404
int32_t tscCreateResPointerInfo(SSqlRes *pRes, SQueryInfo *pQueryInfo);
H
hjxilinx 已提交
405
void    tscDestroyResPointerInfo(SSqlRes *pRes);
H
hzcheng 已提交
406

S
slguan 已提交
407
void tscFreeSqlCmdData(SSqlCmd *pCmd);
H
hjxilinx 已提交
408
void tscFreeResData(SSqlObj *pSql);
H
hzcheng 已提交
409

weixin_48148422's avatar
weixin_48148422 已提交
410 411 412 413
/**
 * free query result of the sql object
 * @param pObj
 */
H
hjxilinx 已提交
414
void tscFreeSqlResult(SSqlObj *pSql);
weixin_48148422's avatar
weixin_48148422 已提交
415

H
hzcheng 已提交
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
/**
 * 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);

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

434 435 436 437 438
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);
439
bool tscHasReachLimitation(SQueryInfo *pQueryInfo, SSqlRes *pRes);
H
hjxilinx 已提交
440

441
char *tscGetErrorMsgPayload(SSqlCmd *pCmd);
442

H
hjxilinx 已提交
443
int32_t tscInvalidSQLErrMsg(char *msg, const char *additionalInfo, const char *sql);
H
hzcheng 已提交
444 445

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

S
slguan 已提交
448 449 450
extern void *     pVnodeConn;
extern void *     pTscMgmtConn;
extern void *     tscCacheHandle;
451
extern int32_t    globalCode;
S
slguan 已提交
452 453 454 455 456 457
extern int        slaveIndex;
extern void *     tscTmr;
extern void *     tscQhandle;
extern int        tscKeepConn[];
extern int        tsInsertHeadSize;
extern int        tscNumOfThreads;
S
slguan 已提交
458
extern SRpcIpSet  tscMgmtIpList;
H
hzcheng 已提交
459

460 461
typedef void (*__async_cb_func_t)(void *param, TAOS_RES *tres, int numOfRows);

H
hzcheng 已提交
462 463 464 465 466
#ifdef __cplusplus
}
#endif

#endif