357 lines
12 KiB
C
357 lines
12 KiB
C
/**************************************
|
||
* FOR OUTSIDE USAGE
|
||
**************************************/
|
||
#if !defined(_TD_TSDB_H_)
|
||
#define _TD_TSDB_H_
|
||
|
||
#include <pthread.h>
|
||
#include <stdbool.h>
|
||
#include <stdint.h>
|
||
|
||
// #include "cache.h"
|
||
#include "schema.h"
|
||
|
||
#define TSDB_VERSION_MAJOR 1
|
||
#define TSDB_VERSION_MINOR 0
|
||
|
||
typedef void tsdb_repo_t; // use void to hide implementation details from outside
|
||
typedef int32_t table_id_t; // table ID type in this repository
|
||
typedef int16_t tsdb_id_t; // TSDB repository ID
|
||
|
||
// Submit message
|
||
typedef struct {
|
||
int32_t numOfTables;
|
||
char data[];
|
||
} SSubmitMsg;
|
||
|
||
// Submit message for one table
|
||
typedef struct {
|
||
table_id_t tableId; // table ID to insert
|
||
int32_t sversion; // data schema version
|
||
int32_t numOfRows; // number of rows data
|
||
int64_t uid; // table UID to insert
|
||
char data[];
|
||
} SSubmitBlock;
|
||
|
||
// Retention policy.
|
||
typedef struct {
|
||
// TODO: Need a more fancy description
|
||
int32_t keep1;
|
||
int32_t keep2;
|
||
int32_t keep3;
|
||
} SRetentionPolicy;
|
||
|
||
// Data sharding policy.
|
||
typedef struct {
|
||
// TODO: Need a more fancy description
|
||
int32_t daysPerFile;
|
||
} SDataShardPolicy;
|
||
|
||
// Rows in file block policy
|
||
typedef struct {
|
||
// TODO: Need a more fancy description
|
||
int32_t minRowsPerFileBlock;
|
||
int32_t maxRowsPerFileBlock;
|
||
} SBlockRowsPolicy;
|
||
|
||
// Applications trying to manipulate a table should provide both uid and tableId.
|
||
// tableId is used for table quick access and uid for verification.
|
||
typedef struct {
|
||
int64_t uid; // the unique table ID
|
||
table_id_t tableId; // the table ID in the repository.
|
||
} STableId;
|
||
|
||
// the TSDB repository configuration
|
||
typedef struct {
|
||
char * rootDir; // TSDB repository root directory, TODO: need to adjust here
|
||
tsdb_id_t tsdbId;
|
||
int32_t maxTables; // maximum number of tables this repository can have
|
||
SDataShardPolicy dataShardPolicy;
|
||
SBlockRowsPolicy blockRowsPolicy;
|
||
SRetentionPolicy retentionPlicy; // retention configuration
|
||
void * cachePool; // the cache pool the repository to use
|
||
} STSDBCfg;
|
||
|
||
// the TSDB repository info
|
||
typedef struct STSDBRepoInfo {
|
||
STSDBCfg tsdbCfg;
|
||
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
|
||
} STSDBRepoInfo;
|
||
|
||
// the meter configuration
|
||
typedef struct {
|
||
char * tableName;
|
||
int64_t uid; // uid given by upper layer
|
||
table_id_t tableId; // table ID allocated from upper layer
|
||
|
||
char *stableName; // if not NULL, the table is created from a super table, need to make sure the super
|
||
// table exists in this TSDB.
|
||
int64_t stableUid;
|
||
|
||
int32_t numOfCols; // number of columns. For table form super table, not includes the tag schema
|
||
SSchema *schema; // If numOfCols == schema_->numOfCols, it is a normal table, stableName = NULL
|
||
// If numOfCols < schema->numOfCols, it is a table created from super table
|
||
// assert(numOfCols <= schema->numOfCols);
|
||
|
||
char *tagValues; // NULL if it is normal table
|
||
// otherwise, it contains the tag values.
|
||
} STableCfg;
|
||
|
||
// the meter information report structure
|
||
typedef struct {
|
||
STableCfg tableCfg;
|
||
int64_t version;
|
||
int64_t tableTotalDataSize; // In bytes
|
||
int64_t tableTotalDiskSize; // In bytes
|
||
} STableInfo;
|
||
|
||
/**
|
||
* Create a new TSDB repository
|
||
* @param pCfg the TSDB repository configuration, upper layer to free the pointer
|
||
* @param error the error number to set when failure occurs
|
||
*
|
||
* @return a TSDB repository handle on success, NULL for failure and the error number is set
|
||
*/
|
||
tsdb_repo_t *tsdbCreateRepo(STSDBCfg *pCfg, int32_t *error);
|
||
|
||
/**
|
||
* Close and free all resources taken by the repository
|
||
* @param pRepo the TSDB repository handle. The interface will free the handle too, so upper
|
||
* layer do NOT need to free the repo handle again.
|
||
* @param error the error number to set when failure occurs
|
||
*
|
||
* @return 0 for success, -1 for failure and the error number is set
|
||
*/
|
||
int32_t tsdbDropRepo(tsdb_repo_t *pRepo, int32_t *error);
|
||
|
||
/**
|
||
* Open an existing TSDB storage repository
|
||
* @param tsdbDir the existing TSDB root directory
|
||
* @param error the error number to set when failure occurs
|
||
*
|
||
* @return a TSDB repository handle on success, NULL for failure and the error number is set
|
||
*/
|
||
tsdb_repo_t *tsdbOpenRepo(char *tsdbDir, int32_t *error);
|
||
|
||
/**
|
||
* Close a TSDB repository. Only free memory resources, and keep the files.
|
||
* @param pRepo the opened TSDB repository handle. The interface will free the handle too, so upper
|
||
* layer do NOT need to free the repo handle again.
|
||
* @param error the error number to set when failure occurs
|
||
*
|
||
* @return 0 for success, -1 for failure and the error number is set
|
||
*/
|
||
int32_t tsdbCloseRepo(tsdb_repo_t *pRepo, int32_t *error);
|
||
|
||
/**
|
||
* Change the configuration of a repository
|
||
* @param pCfg the repository configuration, the upper layer should free the pointer
|
||
* @param error the error number to set when failure occurs
|
||
*
|
||
* @return 0 for success, -1 for failure and the error number is set
|
||
*/
|
||
int32_t tsdbConfigRepo(STSDBCfg *pCfg, int32_t *error);
|
||
|
||
/**
|
||
* Get the TSDB repository information, including some statistics
|
||
* @param pRepo the TSDB repository handle
|
||
* @param error the error number to set when failure occurs
|
||
*
|
||
* @return a info struct handle on success, NULL for failure and the error number is set. The upper
|
||
* layers should free the info handle themselves or memory leak will occur
|
||
*/
|
||
STSDBRepoInfo *tsdbGetStatus(tsdb_repo_t *pRepo, int32_t *error);
|
||
|
||
// -- For table manipulation
|
||
|
||
/**
|
||
* Create/Alter a table in a TSDB repository handle
|
||
* @param pRepo the TSDB repository handle
|
||
* @param pCfg the table configurations, the upper layer should free the pointer
|
||
* @param error the error number to set when failure occurs
|
||
*
|
||
* @return 0 for success, -1 for failure and the error number is set
|
||
*/
|
||
int32_t tsdbCreateTable(tsdb_repo_t *pRepo, STableCfg *pCfg, int32_t *error);
|
||
int32_t tsdbAlterTable(tsdb_repo_t *pRepo, STableCfg *pCfg, int32_t *error);
|
||
|
||
/**
|
||
* Drop a table in a repository and free all the resources it takes
|
||
* @param pRepo the TSDB repository handle
|
||
* @param tid the ID of the table to drop
|
||
* @param error the error number to set when failure occurs
|
||
*
|
||
* @return 0 for success, -1 for failure and the error number is set
|
||
*/
|
||
int32_t tsdbDropTable(tsdb_repo_t *pRepo, STableId tid, int32_t *error);
|
||
|
||
/**
|
||
* Get the information of a table in the repository
|
||
* @param pRepo the TSDB repository handle
|
||
* @param tid the ID of the table to drop
|
||
* @param error the error number to set when failure occurs
|
||
*
|
||
* @return a table information handle for success, NULL for failure and the error number is set
|
||
*/
|
||
STableInfo *tsdbGetTableInfo(tsdb_repo_t *pRepo, STableId tid, int32_t *error);
|
||
|
||
// -- FOR INSERT DATA
|
||
/**
|
||
* Insert data to a table in a repository
|
||
* @param pRepo the TSDB repository handle
|
||
* @param tid the table ID to insert to
|
||
* @param pData the data to insert (will give a more specific description)
|
||
* @param error the error number to set when failure occurs
|
||
*
|
||
* @return the number of points inserted, -1 for failure and the error number is set
|
||
*/
|
||
int32_t tsdbInsertData(tsdb_repo_t *pRepo, STableId tid, char *pData, int32_t *error);
|
||
|
||
// -- FOR QUERY TIME SERIES DATA
|
||
|
||
typedef void tsdb_query_handle_t; // Use void to hide implementation details
|
||
|
||
// time window
|
||
typedef struct STimeWindow {
|
||
int64_t skey;
|
||
int64_t ekey;
|
||
} STimeWindow;
|
||
|
||
typedef struct {
|
||
} SColumnFilterInfo;
|
||
|
||
// query condition to build vnode iterator
|
||
typedef struct STSDBQueryCond {
|
||
STimeWindow twindow;
|
||
int32_t order; // desc/asc order to iterate the data block
|
||
SColumnFilterInfo colFilterInfo;
|
||
} STSDBQueryCond;
|
||
|
||
typedef struct SBlockInfo {
|
||
STimeWindow window;
|
||
|
||
int32_t numOfRows;
|
||
int32_t numOfCols;
|
||
|
||
STableId tableId;
|
||
} SBlockInfo;
|
||
|
||
// TODO: move this data struct out of the module
|
||
typedef struct SData {
|
||
int32_t num;
|
||
char * data;
|
||
} SData;
|
||
|
||
typedef struct SDataBlock {
|
||
int32_t numOfCols;
|
||
SData **pData;
|
||
} SDataBlock;
|
||
|
||
typedef struct STableIDList {
|
||
STableId *tableIds;
|
||
int32_t num;
|
||
} STableIDList;
|
||
|
||
typedef struct {
|
||
|
||
} SFields;
|
||
|
||
/**
|
||
* Get the data block iterator, starting from position according to the query condition
|
||
* @param pRepo the TSDB repository to query on
|
||
* @param pCond query condition, only includes the filter on primary time stamp
|
||
* @param pTableList table sid list
|
||
* @return
|
||
*/
|
||
tsdb_query_handle_t *tsdbQueryFromTableID(tsdb_repo_t *pRepo, STSDBQueryCond *pCond, const STableIDList *pTableList);
|
||
|
||
/**
|
||
* Get iterator for super tables, of which tags values satisfy the tag filter info
|
||
*
|
||
* 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.
|
||
*
|
||
* @param pRepo the repository to query on
|
||
* @param pCond query condition
|
||
* @param pTagFilterStr tag filter info
|
||
* @return
|
||
*/
|
||
tsdb_query_handle_t *tsdbQueryFromTagConds(tsdb_repo_t *pRepo, STSDBQueryCond *pCond, int16_t stableId, const char *pTagFilterStr);
|
||
|
||
/**
|
||
* Reset to the start(end) position of current query, from which the iterator starts.
|
||
*
|
||
* @param pQueryHandle
|
||
* @param position set the iterator traverses position. (TSDB_POS_START|TSDB_POS_END)
|
||
* @return
|
||
*/
|
||
int32_t tsdbResetQuery(tsdb_query_handle_t *pQueryHandle, int16_t position);
|
||
|
||
/**
|
||
* move to next block
|
||
* @param pQueryHandle
|
||
* @param pCond
|
||
* @return
|
||
*/
|
||
bool tsdbIterNext(tsdb_query_handle_t *pQueryHandle);
|
||
|
||
/**
|
||
* 当前数据块的信息，调用next函数后，只会获得block的信息，包括：行数、列数、skey/ekey信息。注意该信息并不是现在的SCompBlockInfo信息。
|
||
* 因为SCompBlockInfo是完整的数据块信息，但是迭代器返回并不是。
|
||
* 查询处理引擎会自己决定需要blockInfo, 还是预计算数据，亦或是完整的数据。
|
||
* Get current data block information
|
||
*
|
||
* @param pQueryHandle
|
||
* @return
|
||
*/
|
||
SBlockInfo tsdbRetrieveDataBlockInfo(tsdb_query_handle_t *pQueryHandle);
|
||
|
||
/**
|
||
* 获取当前数据块的预计算信息，如果块不完整，无预计算信息，如果是cache块，无预计算信息。
|
||
*
|
||
* 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
|
||
* @return
|
||
*/
|
||
int32_t tsdbRetrieveDataBlockStatisInfo(tsdb_query_handle_t *pQueryHandle, SFields *pBlockStatis);
|
||
|
||
/**
|
||
* 返回加载到缓存中的数据，可能是磁盘数据也可能是内存数据，对客户透明。即使是磁盘数据，返回的结果也是磁盘块中，满足查询时间范围要求的数据行，并不是一个完整的磁盘数
|
||
* 据块。
|
||
*
|
||
* 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.
|
||
*
|
||
* @param pQueryHandle
|
||
* @return
|
||
*/
|
||
SDataBlock *tsdbRetrieveDataBlock(tsdb_query_handle_t *pQueryHandle);
|
||
|
||
/**
|
||
* 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.
|
||
*/
|
||
STableIDList *tsdbGetTableList(tsdb_query_handle_t *pQueryHandle);
|
||
|
||
/**
|
||
* Get the qualified table sid for a super table according to the tag query expression.
|
||
* @param stableid. super table sid
|
||
* @param pTagCond. tag query condition
|
||
*
|
||
*/
|
||
STableIDList *tsdbQueryTableList(int16_t stableId, const char *pTagCond);
|
||
|
||
#endif // _TD_TSDB_H_
|