tsdb.h 10.3 KB
Newer Older
H
more  
hzcheng 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * 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/>.
 */
H
hzcheng 已提交
15
#ifndef _TD_TSDB_H_
H
Hongze Cheng 已提交
16 17 18 19 20 21
#define _TD_TSDB_H_

#include <pthread.h>
#include <stdbool.h>
#include <stdint.h>

H
hzcheng 已提交
22
#include "taosdef.h"
H
hzcheng 已提交
23
#include "taosmsg.h"
H
hjxilinx 已提交
24
#include "tarray.h"
H
Hongze Cheng 已提交
25 26
#include "tdataformat.h"
#include "tname.h"
H
Hongze Cheng 已提交
27

H
more  
hzcheng 已提交
28 29 30 31
#ifdef __cplusplus
extern "C" {
#endif

H
Hongze Cheng 已提交
32 33 34
#define TSDB_VERSION_MAJOR 1
#define TSDB_VERSION_MINOR 0

H
hzcheng 已提交
35 36
#define TSDB_INVALID_SUPER_TABLE_ID -1

37
#define TSDB_STATUS_COMMIT_START 1
H
Hongze Cheng 已提交
38
#define TSDB_STATUS_COMMIT_OVER 2
39

H
hzcheng 已提交
40 41 42
// --------- TSDB APPLICATION HANDLE DEFINITION
typedef struct {
  void *appH;
J
jtao1735 已提交
43
  void *cqH;
44
  int (*notifyStatus)(void *, int status);
H
hzcheng 已提交
45
  int (*eventCallBack)(void *);
B
Bomin Zhang 已提交
46
  void *(*cqCreateFunc)(void *handle, uint64_t uid, int sid, char *sqlStr, STSchema *pSchema);
H
TD-354  
Hongze Cheng 已提交
47
  void (*cqDropFunc)(void *handle);
H
TD-90  
Hongze Cheng 已提交
48
  void *(*configFunc)(int32_t vgId, int32_t sid);
H
hzcheng 已提交
49 50
} STsdbAppH;

H
hzcheng 已提交
51 52 53
// --------- TSDB REPOSITORY CONFIGURATION DEFINITION
typedef struct {
  int32_t tsdbId;
S
slguan 已提交
54 55
  int32_t cacheBlockSize;
  int32_t totalBlocks;
H
Hongze Cheng 已提交
56 57 58
  int32_t maxTables;    // maximum number of tables this repository can have
  int32_t daysPerFile;  // day per file sharding policy
  int32_t keep;         // day of data to keep
S
slguan 已提交
59 60
  int32_t keep1;
  int32_t keep2;
H
hzcheng 已提交
61 62
  int32_t minRowsPerFileBlock;  // minimum rows per file block
  int32_t maxRowsPerFileBlock;  // maximum rows per file block
S
slguan 已提交
63 64 65
  int32_t commitTime;
  int8_t  precision;
  int8_t  compression;
H
hzcheng 已提交
66 67
} STsdbCfg;

T
Tao Liu 已提交
68 69
// --------- TSDB REPOSITORY USAGE STATISTICS
typedef struct {
70 71 72 73
  int64_t totalStorage;  // total bytes occupie
  int64_t compStorage;
  int64_t pointsWritten;  // total data points written
} STsdbStat;
T
Tao Liu 已提交
74

H
TD-353  
Hongze Cheng 已提交
75
typedef void TSDB_REPO_T;  // use void to hide implementation details from outside
76

H
TD-353  
Hongze Cheng 已提交
77
STsdbCfg *tsdbGetCfg(const TSDB_REPO_T *repo);
H
hzcheng 已提交
78 79

// --------- TSDB REPOSITORY DEFINITION
H
TD-353  
Hongze Cheng 已提交
80
int          tsdbCreateRepo(char *rootDir, STsdbCfg *pCfg);
H
TD-353  
Hongze Cheng 已提交
81
int32_t      tsdbDropRepo(char *rootDir);
H
TD-353  
Hongze Cheng 已提交
82
TSDB_REPO_T *tsdbOpenRepo(char *rootDir, STsdbAppH *pAppH);
H
TD-353  
Hongze Cheng 已提交
83
void         tsdbCloseRepo(TSDB_REPO_T *repo, int toCommit);
H
Hongze Cheng 已提交
84
int32_t      tsdbConfigRepo(TSDB_REPO_T *repo, STsdbCfg *pCfg);
H
hzcheng 已提交
85 86

// --------- TSDB TABLE DEFINITION
H
more  
hzcheng 已提交
87
typedef struct {
88 89
  uint64_t uid;  // the unique table ID
  int32_t  tid;  // the table ID in the repository.
H
more  
hzcheng 已提交
90 91
} STableId;

H
hzcheng 已提交
92 93
// --------- TSDB TABLE configuration
typedef struct {
H
hzcheng 已提交
94 95 96 97 98
  ETableType type;
  char *     name;
  STableId   tableId;
  int32_t    sversion;
  char *     sname;  // super table name
99
  uint64_t   superUid;
H
hzcheng 已提交
100 101 102
  STSchema * schema;
  STSchema * tagSchema;
  SDataRow   tagValues;
H
TD-354  
Hongze Cheng 已提交
103
  char *     sql;
H
hzcheng 已提交
104 105 106 107
} STableCfg;

void tsdbClearTableCfg(STableCfg *config);

H
Hongze Cheng 已提交
108 109
void *     tsdbGetTableTagVal(TSDB_REPO_T *repo, const STableId *id, int32_t colId, int16_t type, int16_t bytes);
char *     tsdbGetTableName(TSDB_REPO_T *repo, const STableId *id);
H
Hongze Cheng 已提交
110
STableCfg *tsdbCreateTableCfgFromMsg(SMDCreateTableMsg *pMsg);
111

H
TD-353  
Hongze Cheng 已提交
112 113 114 115 116
int   tsdbCreateTable(TSDB_REPO_T *repo, STableCfg *pCfg);
int   tsdbDropTable(TSDB_REPO_T *pRepo, STableId tableId);
int   tsdbUpdateTagValue(TSDB_REPO_T *repo, SUpdateTableTagValMsg *pMsg);
TSKEY tsdbGetTableLastKey(TSDB_REPO_T *repo, uint64_t uid);
void  tsdbStartStream(TSDB_REPO_T *repo);
H
hzcheng 已提交
117

H
TD-353  
Hongze Cheng 已提交
118
uint32_t tsdbGetFileInfo(TSDB_REPO_T *repo, char *name, uint32_t *index, uint32_t eindex, int32_t *size);
119

H
Hongze Cheng 已提交
120
// the TSDB repository info
H
more  
hzcheng 已提交
121
typedef struct STsdbRepoInfo {
H
more  
hzcheng 已提交
122
  STsdbCfg tsdbCfg;
H
Hongze Cheng 已提交
123 124 125 126
  int64_t  version;            // version of the repository
  int64_t  tsdbTotalDataSize;  // the original inserted data size
  int64_t  tsdbTotalDiskSize;  // the total disk size taken by this TSDB repository
  // TODO: Other informations to add
H
more  
hzcheng 已提交
127
} STsdbRepoInfo;
H
TD-353  
Hongze Cheng 已提交
128
STsdbRepoInfo *tsdbGetStatus(TSDB_REPO_T *pRepo);
H
hzcheng 已提交
129

H
Hongze Cheng 已提交
130 131 132 133
// the meter information report structure
typedef struct {
  STableCfg tableCfg;
  int64_t   version;
H
more  
hzcheng 已提交
134 135
  int64_t   tableTotalDataSize;  // In bytes
  int64_t   tableTotalDiskSize;  // In bytes
H
Hongze Cheng 已提交
136
} STableInfo;
H
TD-353  
Hongze Cheng 已提交
137
STableInfo *tsdbGetTableInfo(TSDB_REPO_T *pRepo, STableId tid);
H
Hongze Cheng 已提交
138 139 140 141 142 143 144 145 146

// -- FOR INSERT DATA
/**
 * Insert data to a table in a repository
 * @param pRepo the TSDB repository handle
 * @param pData the data to insert (will give a more specific description)
 *
 * @return the number of points inserted, -1 for failure and the error number is set
 */
H
Hongze Cheng 已提交
147
int32_t tsdbInsertData(TSDB_REPO_T *repo, SSubmitMsg *pMsg, SShellSubmitRspMsg *pRsp);
H
Hongze Cheng 已提交
148 149 150

// -- FOR QUERY TIME SERIES DATA

H
hzcheng 已提交
151
typedef void *TsdbQueryHandleT;  // Use void to hide implementation details
H
Hongze Cheng 已提交
152 153

// query condition to build vnode iterator
H
hjxilinx 已提交
154
typedef struct STsdbQueryCond {
H
Hongze Cheng 已提交
155 156 157 158
  STimeWindow  twindow;
  int32_t      order;  // desc|asc order to iterate the data block
  int32_t      numOfCols;
  SColumnInfo *colList;
H
hjxilinx 已提交
159
} STsdbQueryCond;
H
Hongze Cheng 已提交
160

H
hjxilinx 已提交
161 162
typedef struct SDataBlockInfo {
  STimeWindow window;
163
  int32_t     rows;
H
hjxilinx 已提交
164 165
  int32_t     numOfCols;
  int64_t     uid;
H
hjxilinx 已提交
166
  int32_t     tid;
H
hjxilinx 已提交
167
} SDataBlockInfo;
H
Hongze Cheng 已提交
168

169 170
typedef struct {
  size_t  numOfTables;
H
hzcheng 已提交
171
  SArray *pGroupList;
172 173
} STableGroupInfo;

H
hjxilinx 已提交
174 175 176 177 178
typedef struct SQueryRowCond {
  int32_t rel;
  TSKEY   ts;
} SQueryRowCond;

H
hzcheng 已提交
179
typedef void *TsdbPosT;
H
hjxilinx 已提交
180

H
Hongze Cheng 已提交
181 182
/**
 * Get the data block iterator, starting from position according to the query condition
H
hjxilinx 已提交
183 184 185 186
 *
 * @param tsdb       tsdb handle
 * @param pCond      query condition, including time window, result set order, and basic required columns for each block
 * @param groupInfo  tableId list in the form of set, seperated into different groups according to group by condition
H
Haojun Liao 已提交
187
 * @param qinfo      query info handle from query processor
H
Hongze Cheng 已提交
188 189
 * @return
 */
H
Hongze Cheng 已提交
190
TsdbQueryHandleT *tsdbQueryTables(TSDB_REPO_T *tsdb, STsdbQueryCond *pCond, STableGroupInfo *groupInfo, void *qinfo);
H
Hongze Cheng 已提交
191 192

/**
H
hjxilinx 已提交
193 194 195 196 197
 * Get the last row of the given query time window for all the tables in STableGroupInfo object.
 * Note that only one data block with only row will be returned while invoking retrieve data block function for
 * all tables in this group.
 *
 * @param tsdb        tsdb handle
H
Hongze Cheng 已提交
198 199
 * @param pCond       query condition, including time window, result set order, and basic required columns for each
 * block
H
hjxilinx 已提交
200 201 202
 * @param groupInfo   tableId list.
 * @return
 */
H
Hongze Cheng 已提交
203
TsdbQueryHandleT tsdbQueryLastRow(TSDB_REPO_T *tsdb, STsdbQueryCond *pCond, STableGroupInfo *groupInfo, void *qinfo);
H
hjxilinx 已提交
204

H
Hongze Cheng 已提交
205
SArray *tsdbGetQueriedTableIdList(TsdbQueryHandleT *pHandle);
206

H
Hongze Cheng 已提交
207 208
TsdbQueryHandleT tsdbQueryRowsInExternalWindow(TSDB_REPO_T *tsdb, STsdbQueryCond *pCond, STableGroupInfo *groupList,
                                               void *qinfo);
209

H
hjxilinx 已提交
210 211 212
/**
 * move to next block if exists
 *
H
hjxilinx 已提交
213
 * @param pQueryHandle
H
Hongze Cheng 已提交
214 215
 * @return
 */
H
hzcheng 已提交
216
bool tsdbNextDataBlock(TsdbQueryHandleT *pQueryHandle);
H
Hongze Cheng 已提交
217 218

/**
H
hjxilinx 已提交
219
 * Get current data block information
H
Hongze Cheng 已提交
220 221 222 223
 *
 * @param pQueryHandle
 * @return
 */
H
hzcheng 已提交
224
SDataBlockInfo tsdbRetrieveDataBlockInfo(TsdbQueryHandleT *pQueryHandle);
H
Hongze Cheng 已提交
225 226

/**
H
hjxilinx 已提交
227 228 229 230 231 232 233
 *
 * Get the pre-calculated information w.r.t. current data block.
 *
 * In case of data block in cache, the pBlockStatis will always be NULL.
 * If a block is not completed loaded from disk, the pBlockStatis will be NULL.

 * @pBlockStatis the pre-calculated value for current data blocks. if the block is a cache block, always return 0
H
Hongze Cheng 已提交
234 235
 * @return
 */
H
hzcheng 已提交
236
int32_t tsdbRetrieveDataBlockStatisInfo(TsdbQueryHandleT *pQueryHandle, SDataStatis **pBlockStatis);
H
Hongze Cheng 已提交
237 238

/**
H
hjxilinx 已提交
239
 *
H
hjxilinx 已提交
240 241 242
 * The query condition with primary timestamp is passed to iterator during its constructor function,
 * the returned data block must be satisfied with the time window condition in any cases,
 * which means the SData data block is not actually the completed disk data blocks.
H
Hongze Cheng 已提交
243
 *
H
hjxilinx 已提交
244 245
 * @param pQueryHandle      query handle
 * @param pColumnIdList     required data columns id list
H
Hongze Cheng 已提交
246 247
 * @return
 */
H
hjxilinx 已提交
248
SArray *tsdbRetrieveDataBlock(TsdbQueryHandleT *pQueryHandle, SArray *pColumnIdList);
H
Hongze Cheng 已提交
249 250

/**
H
hjxilinx 已提交
251 252 253 254 255
 * todo remove this function later
 * @param pQueryHandle
 * @param pIdList
 * @return
 */
H
hzcheng 已提交
256
SArray *tsdbRetrieveDataRow(TsdbQueryHandleT *pQueryHandle, SArray *pIdList, SQueryRowCond *pCond);
H
hjxilinx 已提交
257 258 259

/**
 *  Get iterator for super tables, of which tags values satisfy the tag filter info
H
Hongze Cheng 已提交
260
 *
H
hjxilinx 已提交
261 262 263
 *  NOTE: the tagFilterStr is an bin-expression for tag filter, such as ((tag_col = 5) and (tag_col2 > 7))
 *  The filter string is sent from client directly.
 *  The build of the tags filter expression from string is done in the iterator generating function.
H
Hongze Cheng 已提交
264
 *
H
hjxilinx 已提交
265 266
 * @param pCond         query condition
 * @param pTagFilterStr tag filter info
H
Hongze Cheng 已提交
267 268
 * @return
 */
H
hzcheng 已提交
269
TsdbQueryHandleT *tsdbQueryFromTagConds(STsdbQueryCond *pCond, int16_t stableId, const char *pTagFilterStr);
H
Hongze Cheng 已提交
270 271 272 273 274 275 276 277 278

/**
 * Get the qualified tables for (super) table query.
 * Used to handle the super table projection queries, the last_row query, the group by on normal columns query,
 * the interpolation query, and timestamp-comp query for join processing.
 *
 * @param pQueryHandle
 * @return table sid list. the invoker is responsible for the release of this the sid list.
 */
H
hzcheng 已提交
279
SArray *tsdbGetTableList(TsdbQueryHandleT *pQueryHandle);
H
Hongze Cheng 已提交
280 281

/**
282
 * Get the qualified table id for a super table according to the tag query expression.
H
Hongze Cheng 已提交
283 284 285
 * @param stableid. super table sid
 * @param pTagCond. tag query condition
 */
H
TD-353  
Hongze Cheng 已提交
286
int32_t tsdbQuerySTableByTagCond(TSDB_REPO_T *tsdb, uint64_t uid, const char *pTagCond, size_t len,
H
Hongze Cheng 已提交
287 288
                                 int16_t tagNameRelType, const char *tbnameCond, STableGroupInfo *pGroupList,
                                 SColIndex *pColIndex, int32_t numOfCols);
H
hjxilinx 已提交
289 290 291 292 293 294 295 296 297

/**
 * create the table group result including only one table, used to handle the normal table query
 *
 * @param tsdb        tsdbHandle
 * @param uid         table uid
 * @param pGroupInfo  the generated result
 * @return
 */
H
TD-353  
Hongze Cheng 已提交
298
int32_t tsdbGetOneTableGroup(TSDB_REPO_T *tsdb, uint64_t uid, STableGroupInfo *pGroupInfo);
H
Hongze Cheng 已提交
299

300 301 302 303
/**
 * clean up the query handle
 * @param queryHandle
 */
H
hzcheng 已提交
304
void tsdbCleanupQueryHandle(TsdbQueryHandleT queryHandle);
305

T
Tao Liu 已提交
306 307 308 309 310 311 312 313 314
/**
 * get the statistics of repo usage
 * @param repo. point to the tsdbrepo
 * @param totalPoints. total data point written
 * @param totalStorage. total bytes took by the tsdb
 * @param compStorage. total bytes took by the tsdb after compressed
 */
void tsdbReportStat(void *repo, int64_t *totalPoints, int64_t *totalStorage, int64_t *compStorage);

H
more  
hzcheng 已提交
315 316 317 318
#ifdef __cplusplus
}
#endif

陶建辉(Jeff)'s avatar
陶建辉(Jeff) 已提交
319
#endif  // _TD_TSDB_H_