query.h 2.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/*
 * 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_QUERY_H
#define TDENGINE_QUERY_H

#ifdef __cplusplus
extern "C" {
#endif

typedef void* qinfo_t;

/**
 * create the qinfo object according to QueryTableMsg
26
 * @param tsdb
27
 * @param pQueryTableMsg
H
hjxilinx 已提交
28
 * @param qinfo
29 30
 * @return
 */
H
Haojun Liao 已提交
31
int32_t qCreateQueryInfo(void* tsdb, int32_t vgId, SQueryTableMsg* pQueryTableMsg, qinfo_t* qinfo, uint64_t qId);
32 33 34 35 36 37


/**
 * the main query execution function, including query on both table and multitables,
 * which are decided according to the tag or table name query conditions
 *
H
hjxilinx 已提交
38
 * @param qinfo
39 40
 * @return
 */
H
Haojun Liao 已提交
41
bool qTableQuery(qinfo_t qinfo, uint64_t *qId);
42

43 44 45 46 47
/**
 * Retrieve the produced results information, if current query is not paused or completed,
 * this function will be blocked to wait for the query execution completed or paused,
 * in which case enough results have been produced already.
 *
H
hjxilinx 已提交
48
 * @param qinfo
49 50
 * @return
 */
51
int32_t qRetrieveQueryResultInfo(qinfo_t qinfo, bool* buildRes, void* pRspContext);
52 53 54 55 56 57

/**
 *
 * Retrieve the actual results to fill the response message payload.
 * Note that this function must be executed after qRetrieveQueryResultInfo is invoked.
 *
H
hjxilinx 已提交
58
 * @param qinfo  qinfo object
59 60 61 62
 * @param pRsp    response message
 * @param contLen payload length
 * @return
 */
63
int32_t qDumpRetrieveResult(qinfo_t qinfo, SRetrieveTableRsp** pRsp, int32_t* contLen, bool* continueExec);
64

H
Haojun Liao 已提交
65 66 67 68 69
/**
 *
 * @param qinfo
 * @return
 */
70
void* qGetResultRetrieveMsg(qinfo_t qinfo);
71

H
Haojun Liao 已提交
72 73
/**
 * kill current ongoing query and free query handle automatically
74 75
 * @param qinfo  qhandle
 * @return
H
Haojun Liao 已提交
76
 */
H
Haojun Liao 已提交
77
int32_t qKillQuery(qinfo_t qinfo);
H
Haojun Liao 已提交
78

A
AlexDuan 已提交
79 80 81
//kill by qid 
int32_t qKillQueryByQId(void* pMgmt, int64_t qId, int32_t waitMs, int32_t waitCount);

82 83
bool qSolveCommitNoBlock(void* pRepo, void* pMgmt);

84 85
int32_t qQueryCompleted(qinfo_t qinfo);

86 87 88 89 90 91
/**
 * destroy query info structure
 * @param qHandle
 */
void qDestroyQueryInfo(qinfo_t qHandle);

92
void* qOpenQueryMgmt(int32_t vgId);
93
void  qQueryMgmtNotifyClosed(void* pExecutor);
S
TD-2640  
Shengliang Guan 已提交
94
void  qQueryMgmtReOpen(void *pExecutor);
95
void  qCleanupQueryMgmt(void* pExecutor);
96
void** qRegisterQInfo(void* pMgmt, uint64_t qId, void *qInfo);
97
void** qAcquireQInfo(void* pMgmt, uint64_t key);
H
Haojun Liao 已提交
98
void** qReleaseQInfo(void* pMgmt, void* pQInfo, bool freeHandle);
D
fix bug  
dapan1121 已提交
99
bool checkQIdEqual(void *qHandle, uint64_t qId);
D
dapan1121 已提交
100
int64_t genQueryId(void);
101

102 103 104 105 106
#ifdef __cplusplus
}
#endif

#endif  // TDENGINE_QUERY_H