tsdb.h 9.7 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>

S
slguan 已提交
22 23
#include "tdataformat.h"
#include "tname.h"
H
hzcheng 已提交
24
#include "taosdef.h"
H
hzcheng 已提交
25
#include "taosmsg.h"
H
hjxilinx 已提交
26
#include "tarray.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 38 39
#define TSDB_STATUS_COMMIT_START 1
#define TSDB_STATUS_COMMIT_OVER  2

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 46 47
  int (*eventCallBack)(void *);
} STsdbAppH;

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

void      tsdbSetDefaultCfg(STsdbCfg *pCfg);
STsdbCfg *tsdbCreateDefaultCfg();
void      tsdbFreeCfg(STsdbCfg *pCfg);

// --------- TSDB REPOSITORY DEFINITION
H
hzcheng 已提交
70
typedef void TsdbRepoT;  // use void to hide implementation details from outside
H
hzcheng 已提交
71

H
hzcheng 已提交
72 73 74 75 76
int        tsdbCreateRepo(char *rootDir, STsdbCfg *pCfg, void *limiter);
int32_t    tsdbDropRepo(TsdbRepoT *repo);
TsdbRepoT *tsdbOpenRepo(char *tsdbDir, STsdbAppH *pAppH);
int32_t    tsdbCloseRepo(TsdbRepoT *repo);
int32_t    tsdbConfigRepo(TsdbRepoT *repo, STsdbCfg *pCfg);
H
hzcheng 已提交
77 78

// --------- TSDB TABLE DEFINITION
H
more  
hzcheng 已提交
79
typedef struct {
H
more  
hzcheng 已提交
80 81
  int64_t uid;  // the unique table ID
  int32_t tid;  // the table ID in the repository.
H
more  
hzcheng 已提交
82 83
} STableId;

H
hzcheng 已提交
84 85
// --------- TSDB TABLE configuration
typedef struct {
H
hzcheng 已提交
86 87 88 89 90 91 92 93 94
  ETableType type;
  char *     name;
  STableId   tableId;
  int32_t    sversion;
  char *     sname;  // super table name
  int64_t    superUid;
  STSchema * schema;
  STSchema * tagSchema;
  SDataRow   tagValues;
H
hzcheng 已提交
95 96
} STableCfg;

S
slguan 已提交
97
int  tsdbInitTableCfg(STableCfg *config, ETableType type, int64_t uid, int32_t tid);
H
hzcheng 已提交
98 99 100 101
int  tsdbTableSetSuperUid(STableCfg *config, int64_t uid);
int  tsdbTableSetSchema(STableCfg *config, STSchema *pSchema, bool dup);
int  tsdbTableSetTagSchema(STableCfg *config, STSchema *pSchema, bool dup);
int  tsdbTableSetTagValue(STableCfg *config, SDataRow row, bool dup);
H
hzcheng 已提交
102 103
int  tsdbTableSetName(STableCfg *config, char *name, bool dup);
int  tsdbTableSetSName(STableCfg *config, char *sname, bool dup);
H
hzcheng 已提交
104 105
void tsdbClearTableCfg(STableCfg *config);

H
hjxilinx 已提交
106
int32_t tsdbGetTableTagVal(TsdbRepoT *repo, STableId* id, int32_t colId, int16_t *type, int16_t *bytes, char **val);
H
hjxilinx 已提交
107
char* tsdbGetTableName(TsdbRepoT *repo, const STableId* id, int16_t* bytes);
108

H
hzcheng 已提交
109 110 111 112
int   tsdbCreateTable(TsdbRepoT *repo, STableCfg *pCfg);
int   tsdbDropTable(TsdbRepoT *pRepo, STableId tableId);
int   tsdbAlterTable(TsdbRepoT *repo, STableCfg *pCfg);
TSKEY tsdbGetTableLastKey(TsdbRepoT *repo, int64_t uid);
H
hzcheng 已提交
113

114 115
uint32_t tsdbGetFileInfo(TsdbRepoT *repo, char *name, uint32_t *index, int32_t *size);

H
Hongze Cheng 已提交
116
// the TSDB repository info
H
more  
hzcheng 已提交
117
typedef struct STsdbRepoInfo {
H
more  
hzcheng 已提交
118
  STsdbCfg tsdbCfg;
H
Hongze Cheng 已提交
119 120 121 122
  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 已提交
123
} STsdbRepoInfo;
H
hzcheng 已提交
124
STsdbRepoInfo *tsdbGetStatus(TsdbRepoT *pRepo);
H
hzcheng 已提交
125

H
Hongze Cheng 已提交
126 127 128 129
// the meter information report structure
typedef struct {
  STableCfg tableCfg;
  int64_t   version;
H
more  
hzcheng 已提交
130 131
  int64_t   tableTotalDataSize;  // In bytes
  int64_t   tableTotalDiskSize;  // In bytes
H
Hongze Cheng 已提交
132
} STableInfo;
H
hzcheng 已提交
133
STableInfo *tsdbGetTableInfo(TsdbRepoT *pRepo, STableId tid);
H
Hongze Cheng 已提交
134 135 136 137 138 139 140 141 142

// -- 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
hzcheng 已提交
143
int32_t tsdbInsertData(TsdbRepoT *pRepo, SSubmitMsg *pMsg);
H
Hongze Cheng 已提交
144 145 146

// -- FOR QUERY TIME SERIES DATA

H
hzcheng 已提交
147
typedef void *TsdbQueryHandleT;  // Use void to hide implementation details
H
Hongze Cheng 已提交
148 149

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

H
hjxilinx 已提交
157 158
typedef struct SDataBlockInfo {
  STimeWindow window;
159
  int32_t     rows;
H
hjxilinx 已提交
160 161
  int32_t     numOfCols;
  int64_t     uid;
H
hjxilinx 已提交
162
  int32_t     tid;
H
hjxilinx 已提交
163
} SDataBlockInfo;
H
Hongze Cheng 已提交
164

165 166
typedef struct {
  size_t  numOfTables;
H
hzcheng 已提交
167
  SArray *pGroupList;
168 169
} STableGroupInfo;

H
more  
hzcheng 已提交
170 171 172
typedef struct {
} SFields;

H
hjxilinx 已提交
173
#define TSDB_TS_GREATER_EQUAL 1
H
hzcheng 已提交
174
#define TSDB_TS_LESS_EQUAL 2
H
hjxilinx 已提交
175 176 177 178 179 180

typedef struct SQueryRowCond {
  int32_t rel;
  TSKEY   ts;
} SQueryRowCond;

H
hzcheng 已提交
181
typedef void *TsdbPosT;
H
hjxilinx 已提交
182

H
Hongze Cheng 已提交
183 184
/**
 * Get the data block iterator, starting from position according to the query condition
H
hjxilinx 已提交
185 186 187 188
 *
 * @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
Hongze Cheng 已提交
189 190
 * @return
 */
H
hjxilinx 已提交
191
TsdbQueryHandleT *tsdbQueryTables(TsdbRepoT *tsdb, STsdbQueryCond *pCond, STableGroupInfo *groupInfo);
H
Hongze Cheng 已提交
192 193

/**
H
hjxilinx 已提交
194 195 196 197 198 199 200 201 202 203 204 205 206 207
 * 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
 * @param pCond       query condition, including time window, result set order, and basic required columns for each block
 * @param groupInfo   tableId list.
 * @return
 */
TsdbQueryHandleT tsdbQueryLastRow(TsdbRepoT *tsdb, STsdbQueryCond *pCond, STableGroupInfo *groupInfo);

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

/**
H
hjxilinx 已提交
214
 * Get current data block information
H
Hongze Cheng 已提交
215 216 217 218
 *
 * @param pQueryHandle
 * @return
 */
H
hzcheng 已提交
219
SDataBlockInfo tsdbRetrieveDataBlockInfo(TsdbQueryHandleT *pQueryHandle);
H
Hongze Cheng 已提交
220 221

/**
H
hjxilinx 已提交
222 223 224 225 226 227 228
 *
 * 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 已提交
229 230
 * @return
 */
H
hzcheng 已提交
231
int32_t tsdbRetrieveDataBlockStatisInfo(TsdbQueryHandleT *pQueryHandle, SDataStatis **pBlockStatis);
H
Hongze Cheng 已提交
232 233

/**
H
hjxilinx 已提交
234
 *
H
hjxilinx 已提交
235 236 237
 * 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 已提交
238
 *
H
hjxilinx 已提交
239 240
 * @param pQueryHandle      query handle
 * @param pColumnIdList     required data columns id list
H
Hongze Cheng 已提交
241 242
 * @return
 */
H
hjxilinx 已提交
243
SArray *tsdbRetrieveDataBlock(TsdbQueryHandleT *pQueryHandle, SArray *pColumnIdList);
H
Hongze Cheng 已提交
244 245

/**
H
hjxilinx 已提交
246 247 248 249 250
 * todo remove this function later
 * @param pQueryHandle
 * @param pIdList
 * @return
 */
H
hzcheng 已提交
251
SArray *tsdbRetrieveDataRow(TsdbQueryHandleT *pQueryHandle, SArray *pIdList, SQueryRowCond *pCond);
H
hjxilinx 已提交
252 253 254

/**
 *  Get iterator for super tables, of which tags values satisfy the tag filter info
H
Hongze Cheng 已提交
255
 *
H
hjxilinx 已提交
256 257 258
 *  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 已提交
259
 *
H
hjxilinx 已提交
260 261
 * @param pCond         query condition
 * @param pTagFilterStr tag filter info
H
Hongze Cheng 已提交
262 263
 * @return
 */
H
hzcheng 已提交
264
TsdbQueryHandleT *tsdbQueryFromTagConds(STsdbQueryCond *pCond, int16_t stableId, const char *pTagFilterStr);
H
Hongze Cheng 已提交
265 266 267 268 269 270 271 272 273

/**
 * 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 已提交
274
SArray *tsdbGetTableList(TsdbQueryHandleT *pQueryHandle);
H
Hongze Cheng 已提交
275 276

/**
277
 * Get the qualified table id for a super table according to the tag query expression.
H
Hongze Cheng 已提交
278 279 280
 * @param stableid. super table sid
 * @param pTagCond. tag query condition
 */
H
hjxilinx 已提交
281 282
int32_t tsdbQuerySTableByTagCond(TsdbRepoT *tsdb, int64_t uid, const char *pTagCond, size_t len,
  int16_t tagNameRelType, const char* tbnameCond, STableGroupInfo *pGroupList, SColIndex *pColIndex, int32_t numOfCols);
283

H
hjxilinx 已提交
284 285 286 287 288 289 290 291 292

/**
 * 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
hzcheng 已提交
293
int32_t tsdbGetOneTableGroup(TsdbRepoT *tsdb, int64_t uid, STableGroupInfo *pGroupInfo);
H
Hongze Cheng 已提交
294

295 296 297 298
/**
 * clean up the query handle
 * @param queryHandle
 */
H
hzcheng 已提交
299
void tsdbCleanupQueryHandle(TsdbQueryHandleT queryHandle);
300

H
more  
hzcheng 已提交
301 302 303 304
#ifdef __cplusplus
}
#endif

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