executor.h 4.1 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;
H
Haojun Liao 已提交
39
} SReadHandle;
40

41 42 43 44
enum {
  STREAM_DATA_TYPE_SUBMIT_BLOCK = 1,
  STREAM_DATA_TYPE_SSDATA_BLOCK = 2,
};
L
Liu Jicong 已提交
45

46
typedef enum {
47
  OPTR_EXEC_MODEL_BATCH = 0x1,
48 49 50
  OPTR_EXEC_MODEL_STREAM = 0x2,
} EOPTR_EXEC_MODEL;

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

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

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

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

L
Liu Jicong 已提交
88 89 90 91 92 93 94 95 96 97
/**
 * 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,
98
                        qTaskInfo_t* pTaskInfo, DataSinkHandle* handle, const char* sql, EOPTR_EXEC_MODEL model);
H
Haojun Liao 已提交
99

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

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

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

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

H
Haojun Liao 已提交
134 135
/**
 * return whether query is completed or not
H
Haojun Liao 已提交
136
 * @param tinfo
H
Haojun Liao 已提交
137 138
 * @return
 */
H
Haojun Liao 已提交
139
int32_t qIsTaskCompleted(qTaskInfo_t tinfo);
H
Haojun Liao 已提交
140 141 142 143 144

/**
 * destroy query info structure
 * @param qHandle
 */
H
Haojun Liao 已提交
145
void qDestroyTask(qTaskInfo_t tinfo);
H
Haojun Liao 已提交
146 147 148 149 150 151

/**
 * Get the queried table uid
 * @param qHandle
 * @return
 */
H
Haojun Liao 已提交
152
int64_t qGetQueriedTableUid(qTaskInfo_t tinfo);
H
Haojun Liao 已提交
153 154 155 156 157 158 159 160 161 162

/**
 * 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 已提交
163
void qProcessFetchRsp(void* parent, struct SRpcMsg* pMsg, struct SEpSet* pEpSet);
S
Shengliang 已提交
164

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

H
Hongze Cheng 已提交
167 168 169 170
#ifdef __cplusplus
}
#endif

171
#endif /*_TD_EXECUTOR_H_*/