executor.h 4.5 KB
Newer Older
H
Hongze Cheng 已提交
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 _TD_EXECUTOR_H_
#define _TD_EXECUTOR_H_

#ifdef __cplusplus
extern "C" {
#endif

D
dapan1121 已提交
23
#include "query.h"
L
Liu Jicong 已提交
24
#include "tcommon.h"
25
#include "tmsgcb.h"
D
dapan1121 已提交
26

H
Haojun Liao 已提交
27
typedef void* qTaskInfo_t;
H
Haojun Liao 已提交
28
typedef void* DataSinkHandle;
S
Shengliang 已提交
29
struct SRpcMsg;
H
Haojun Liao 已提交
30 31
struct SSubplan;

H
Haojun Liao 已提交
32
typedef struct SReadHandle {
33 34 35 36 37 38
  void*   reader;
  void*   meta;
  void*   config;
  void*   vnode;
  void*   mnd;
  SMsgCb* pMsgCb;
L
Liu Jicong 已提交
39
  bool    tqReader;
H
Haojun Liao 已提交
40
} SReadHandle;
41

42
typedef enum {
43
  OPTR_EXEC_MODEL_BATCH = 0x1,
44 45 46
  OPTR_EXEC_MODEL_STREAM = 0x2,
} EOPTR_EXEC_MODEL;

L
Liu Jicong 已提交
47 48 49 50 51 52 53
/**
 * Create the exec task for streaming mode
 * @param pMsg
 * @param streamReadHandle
 * @return
 */
qTaskInfo_t qCreateStreamExecTaskInfo(void* msg, void* streamReadHandle);
54

L
Liu Jicong 已提交
55 56 57 58 59 60 61
/**
 * Switch the stream scan to snapshot mode
 * @param tinfo
 * @return
 */
int32_t qStreamScanSnapshot(qTaskInfo_t tinfo);

H
Haojun Liao 已提交
62
/**
63
 * Set the input data block for the stream scan.
H
Haojun Liao 已提交
64 65
 * @param tinfo
 * @param input
H
Haojun Liao 已提交
66
 * @param type
H
Haojun Liao 已提交
67 68
 * @return
 */
69
int32_t qSetStreamInput(qTaskInfo_t tinfo, const void* input, int32_t type, bool assignUid);
H
Haojun Liao 已提交
70

H
Haojun Liao 已提交
71 72 73 74 75 76 77 78
/**
 * Set multiple input data blocks for the stream scan.
 * @param tinfo
 * @param pBlocks
 * @param numOfInputBlock
 * @param type
 * @return
 */
79
int32_t qSetMultiStreamInput(qTaskInfo_t tinfo, const void* pBlocks, size_t numOfBlocks, int32_t type, bool assignUid);
H
Haojun Liao 已提交
80

81 82 83 84 85 86 87 88
/**
 * Update the table id list, add or remove.
 *
 * @param tinfo
 * @param id
 * @param isAdd
 * @return
 */
89
int32_t qUpdateQualifiedTableId(qTaskInfo_t tinfo, const SArray* tableIdList, bool isAdd);
90

L
Liu Jicong 已提交
91 92 93 94 95 96 97 98 99 100
/**
 * Create the exec task object according to task json
 * @param readHandle
 * @param vgId
 * @param pTaskInfoMsg
 * @param pTaskInfo
 * @param qId
 * @return
 */
int32_t qCreateExecTask(SReadHandle* readHandle, int32_t vgId, uint64_t taskId, struct SSubplan* pPlan,
101
                        qTaskInfo_t* pTaskInfo, DataSinkHandle* handle, const char* sql, EOPTR_EXEC_MODEL model);
H
Haojun Liao 已提交
102

103 104 105 106 107 108 109
/**
 *
 * @param tinfo
 * @param sversion
 * @param tversion
 * @return
 */
110 111
int32_t qGetQueriedTableSchemaVersion(qTaskInfo_t tinfo, char* dbName, char* tableName, int32_t* sversion,
                                      int32_t* tversion);
112

H
Haojun Liao 已提交
113
/**
H
Haojun Liao 已提交
114
 * The main task execution function, including query on both table and multiple tables,
H
Haojun Liao 已提交
115 116
 * which are decided according to the tag or table name query conditions
 *
H
Haojun Liao 已提交
117 118
 * @param tinfo
 * @param handle
H
Haojun Liao 已提交
119 120
 * @return
 */
L
Liu Jicong 已提交
121
int32_t qExecTask(qTaskInfo_t tinfo, SSDataBlock** pRes, uint64_t* useconds);
H
Haojun Liao 已提交
122 123 124

/**
 * kill the ongoing query and free the query handle and corresponding resources automatically
H
Haojun Liao 已提交
125
 * @param tinfo  qhandle
H
Haojun Liao 已提交
126 127
 * @return
 */
H
Haojun Liao 已提交
128
int32_t qKillTask(qTaskInfo_t tinfo);
H
Haojun Liao 已提交
129

D
dapan1121 已提交
130 131
/**
 * kill the ongoing query asynchronously
H
Haojun Liao 已提交
132
 * @param tinfo  qhandle
D
dapan1121 已提交
133 134
 * @return
 */
H
Haojun Liao 已提交
135
int32_t qAsyncKillTask(qTaskInfo_t tinfo);
D
dapan1121 已提交
136

H
Haojun Liao 已提交
137 138 139 140
/**
 * destroy query info structure
 * @param qHandle
 */
H
Haojun Liao 已提交
141
void qDestroyTask(qTaskInfo_t tinfo);
H
Haojun Liao 已提交
142 143 144 145 146 147

/**
 * Get the queried table uid
 * @param qHandle
 * @return
 */
H
Haojun Liao 已提交
148
int64_t qGetQueriedTableUid(qTaskInfo_t tinfo);
H
Haojun Liao 已提交
149 150 151 152 153 154 155 156 157

/**
 * Extract the qualified table id list, and than pass them to the TSDB driver to load the required table data blocks.
 *
 * @param iter  the table iterator to traverse all tables belongs to a super table, or an invert index
 * @return
 */
int32_t qGetQualifiedTableIdList(void* pTableList, const char* tagCond, int32_t tagCondLen, SArray* pTableIdList);

S
Shengliang Guan 已提交
158
void qProcessFetchRsp(void* parent, struct SRpcMsg* pMsg, struct SEpSet* pEpSet);
S
Shengliang 已提交
159

160
int32_t qGetExplainExecInfo(qTaskInfo_t tinfo, int32_t* resNum, SExplainExecInfo** pRes);
D
dapan1121 已提交
161

162 163 164 165
int32_t qSerializeTaskStatus(qTaskInfo_t tinfo, char** pOutput, int32_t* len);

int32_t qDeserializeTaskStatus(qTaskInfo_t tinfo, const char* pInput, int32_t len);

166 167 168 169 170 171 172 173 174
/**
 * return the scan info, in the form of tuple of two items, including table uid and current timestamp
 * @param tinfo
 * @param uid
 * @param ts
 * @return
 */
int32_t qGetStreamScanStatus(qTaskInfo_t tinfo, uint64_t* uid, int64_t* ts);

175
int32_t qStreamPrepareScan(qTaskInfo_t tinfo, uint64_t uid, int64_t ts);
L
Liu Jicong 已提交
176

H
Hongze Cheng 已提交
177 178 179 180
#ifdef __cplusplus
}
#endif

181
#endif /*_TD_EXECUTOR_H_*/