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

H
hzcheng 已提交
37 38 39 40 41 42 43 44 45
// --------- TSDB APPLICATION HANDLE DEFINITION
typedef struct {
  // WAL handle
  void *appH;
  int (*walCallBack)(void *);
  int (*eventCallBack)(void *);
  int (*cqueryCallBack)(void *);
} STsdbAppH;

H
hzcheng 已提交
46 47 48
// --------- TSDB REPOSITORY CONFIGURATION DEFINITION
typedef struct {
  int8_t  precision;
H
TD-100  
hzcheng 已提交
49
  int8_t  compression;
H
hzcheng 已提交
50 51 52 53 54 55 56 57 58 59 60 61 62 63
  int32_t tsdbId;
  int32_t maxTables;            // maximum number of tables this repository can have
  int32_t daysPerFile;          // day per file sharding policy
  int32_t minRowsPerFileBlock;  // minimum rows per file block
  int32_t maxRowsPerFileBlock;  // maximum rows per file block
  int32_t keep;                 // day of data to keep
  int64_t maxCacheSize;         // maximum cache size this TSDB can use
} STsdbCfg;

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

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

H
hzcheng 已提交
66 67 68 69 70
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 已提交
71 72

// --------- TSDB TABLE DEFINITION
H
more  
hzcheng 已提交
73
typedef struct {
H
more  
hzcheng 已提交
74 75
  int64_t uid;  // the unique table ID
  int32_t tid;  // the table ID in the repository.
H
more  
hzcheng 已提交
76 77
} STableId;

H
hzcheng 已提交
78 79
// --------- TSDB TABLE configuration
typedef struct {
H
hzcheng 已提交
80 81 82 83 84 85 86 87 88
  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 已提交
89 90
} STableCfg;

S
slguan 已提交
91
int  tsdbInitTableCfg(STableCfg *config, ETableType type, int64_t uid, int32_t tid);
H
hzcheng 已提交
92 93 94 95
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 已提交
96 97
int  tsdbTableSetName(STableCfg *config, char *name, bool dup);
int  tsdbTableSetSName(STableCfg *config, char *sname, bool dup);
H
hzcheng 已提交
98 99
void tsdbClearTableCfg(STableCfg *config);

H
hjxilinx 已提交
100 101
int32_t tsdbGetTableTagVal(TsdbRepoT *repo, STableId* id, int32_t col, int16_t *type, int16_t *bytes, char **val);
int32_t tsdbTableGetName(TsdbRepoT *repo, STableId* id, char** name);
102

H
hzcheng 已提交
103 104 105
int tsdbCreateTable(TsdbRepoT *repo, STableCfg *pCfg);
int tsdbDropTable(TsdbRepoT *pRepo, STableId tableId);
int tsdbAlterTable(TsdbRepoT *repo, STableCfg *pCfg);
H
hzcheng 已提交
106

H
Hongze Cheng 已提交
107
// the TSDB repository info
H
more  
hzcheng 已提交
108
typedef struct STsdbRepoInfo {
H
more  
hzcheng 已提交
109
  STsdbCfg tsdbCfg;
H
Hongze Cheng 已提交
110 111 112 113
  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 已提交
114
} STsdbRepoInfo;
H
hzcheng 已提交
115
STsdbRepoInfo *tsdbGetStatus(TsdbRepoT *pRepo);
H
hzcheng 已提交
116

H
Hongze Cheng 已提交
117 118 119 120
// the meter information report structure
typedef struct {
  STableCfg tableCfg;
  int64_t   version;
H
more  
hzcheng 已提交
121 122
  int64_t   tableTotalDataSize;  // In bytes
  int64_t   tableTotalDiskSize;  // In bytes
H
Hongze Cheng 已提交
123
} STableInfo;
H
hzcheng 已提交
124
STableInfo *tsdbGetTableInfo(TsdbRepoT *pRepo, STableId tid);
H
Hongze Cheng 已提交
125 126 127 128 129 130 131 132 133

// -- 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 已提交
134
int32_t tsdbInsertData(TsdbRepoT *pRepo, SSubmitMsg *pMsg);
H
Hongze Cheng 已提交
135 136 137

// -- FOR QUERY TIME SERIES DATA

H
hzcheng 已提交
138
typedef void *TsdbQueryHandleT;  // Use void to hide implementation details
H
Hongze Cheng 已提交
139

H
hzcheng 已提交
140 141 142
typedef struct STableGroupList {  // qualified table object list in group
  SArray *pGroupList;
  int32_t numOfTables;
143
} STableGroupList;
H
Hongze Cheng 已提交
144 145

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

H
hjxilinx 已提交
153 154
typedef struct SDataBlockInfo {
  STimeWindow window;
155
  int32_t     rows;
H
hjxilinx 已提交
156 157
  int32_t     numOfCols;
  int64_t     uid;
H
hjxilinx 已提交
158
  int32_t     tid;
H
hjxilinx 已提交
159
} SDataBlockInfo;
H
Hongze Cheng 已提交
160

161 162
typedef struct {
  size_t  numOfTables;
H
hzcheng 已提交
163
  SArray *pGroupList;
164 165
} STableGroupInfo;

H
more  
hzcheng 已提交
166 167 168
typedef struct {
} SFields;

H
hjxilinx 已提交
169
#define TSDB_TS_GREATER_EQUAL 1
H
hzcheng 已提交
170
#define TSDB_TS_LESS_EQUAL 2
H
hjxilinx 已提交
171 172 173 174 175 176

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

H
hzcheng 已提交
177
typedef void *TsdbPosT;
H
hjxilinx 已提交
178

H
Hongze Cheng 已提交
179 180 181 182 183 184
/**
 * Get the data block iterator, starting from position according to the query condition
 * @param pCond  query condition, only includes the filter on primary time stamp
 * @param pTableList    table sid list
 * @return
 */
H
hjxilinx 已提交
185
TsdbQueryHandleT *tsdbQueryTables(TsdbRepoT *tsdb, STsdbQueryCond *pCond, STableGroupInfo *groupInfo);
H
Hongze Cheng 已提交
186 187

/**
H
hjxilinx 已提交
188 189
 * move to next block
 * @param pQueryHandle
H
Hongze Cheng 已提交
190 191
 * @return
 */
H
hzcheng 已提交
192
bool tsdbNextDataBlock(TsdbQueryHandleT *pQueryHandle);
H
Hongze Cheng 已提交
193 194

/**
H
hjxilinx 已提交
195
 * Get current data block information
H
Hongze Cheng 已提交
196 197 198 199
 *
 * @param pQueryHandle
 * @return
 */
H
hzcheng 已提交
200
SDataBlockInfo tsdbRetrieveDataBlockInfo(TsdbQueryHandleT *pQueryHandle);
H
Hongze Cheng 已提交
201 202

/**
H
hjxilinx 已提交
203 204 205 206 207 208 209
 *
 * 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 已提交
210 211
 * @return
 */
H
hzcheng 已提交
212
int32_t tsdbRetrieveDataBlockStatisInfo(TsdbQueryHandleT *pQueryHandle, SDataStatis **pBlockStatis);
H
Hongze Cheng 已提交
213 214

/**
H
hjxilinx 已提交
215 216 217
 * 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 已提交
218 219 220 221
 *
 * @param pQueryHandle
 * @return
 */
H
hzcheng 已提交
222
SArray *tsdbRetrieveDataBlock(TsdbQueryHandleT *pQueryHandle, SArray *pIdList);
H
Hongze Cheng 已提交
223 224

/**
H
hjxilinx 已提交
225
 *  todo remove the parameter of position, and order type
H
Hongze Cheng 已提交
226
 *
H
hjxilinx 已提交
227
 *  Reset to the start(end) position of current query, from which the iterator starts.
H
Hongze Cheng 已提交
228
 *
H
hjxilinx 已提交
229 230 231 232 233
 * @param pQueryHandle
 * @param position  set the iterator traverses position
 * @param order ascending order or descending order
 * @return
 */
H
hzcheng 已提交
234
int32_t tsdbResetQuery(TsdbQueryHandleT *pQueryHandle, STimeWindow *window, TsdbPosT position, int16_t order);
H
Hongze Cheng 已提交
235 236

/**
H
hjxilinx 已提交
237 238 239 240 241
 * todo remove this function later
 * @param pQueryHandle
 * @param pIdList
 * @return
 */
H
hzcheng 已提交
242
SArray *tsdbRetrieveDataRow(TsdbQueryHandleT *pQueryHandle, SArray *pIdList, SQueryRowCond *pCond);
H
hjxilinx 已提交
243 244 245

/**
 *  Get iterator for super tables, of which tags values satisfy the tag filter info
H
Hongze Cheng 已提交
246
 *
H
hjxilinx 已提交
247 248 249
 *  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 已提交
250
 *
H
hjxilinx 已提交
251 252
 * @param pCond         query condition
 * @param pTagFilterStr tag filter info
H
Hongze Cheng 已提交
253 254
 * @return
 */
H
hzcheng 已提交
255
TsdbQueryHandleT *tsdbQueryFromTagConds(STsdbQueryCond *pCond, int16_t stableId, const char *pTagFilterStr);
H
Hongze Cheng 已提交
256 257 258 259 260 261 262 263 264

/**
 * 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 已提交
265
SArray *tsdbGetTableList(TsdbQueryHandleT *pQueryHandle);
H
Hongze Cheng 已提交
266 267

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

H
hzcheng 已提交
285
int32_t tsdbGetOneTableGroup(TsdbRepoT *tsdb, int64_t uid, STableGroupInfo *pGroupInfo);
H
Hongze Cheng 已提交
286

287 288 289 290
/**
 * clean up the query handle
 * @param queryHandle
 */
H
hzcheng 已提交
291
void tsdbCleanupQueryHandle(TsdbQueryHandleT queryHandle);
292

H
more  
hzcheng 已提交
293 294 295 296
#ifdef __cplusplus
}
#endif

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