tdataformat.h 5.2 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_DATA_FORMAT_H_
H
more  
Hongze Cheng 已提交
16 17 18
#define _TD_DATA_FORMAT_H_

#include <stdint.h>
H
hzcheng 已提交
19
#include <stdlib.h>
H
hzcheng 已提交
20
#include <string.h>
H
more  
Hongze Cheng 已提交
21

H
hzcheng 已提交
22 23
#include "taosdef.h"

H
more  
hzcheng 已提交
24 25 26
#ifdef __cplusplus
extern "C" {
#endif
H
hzcheng 已提交
27 28 29 30 31 32

// ----------------- TSDB COLUMN DEFINITION
typedef struct {
  int8_t  type;    // Column type
  int16_t colId;   // column ID
  int32_t bytes;   // column bytes
H
TD-166  
hzcheng 已提交
33
  int32_t offset;  // point offset in SDataRow after the header part
H
hzcheng 已提交
34 35 36 37 38 39 40 41 42 43 44 45 46 47
} STColumn;

#define colType(col) ((col)->type)
#define colColId(col) ((col)->colId)
#define colBytes(col) ((col)->bytes)
#define colOffset(col) ((col)->offset)

#define colSetType(col, t) (colType(col) = (t))
#define colSetColId(col, id) (colColId(col) = (id))
#define colSetBytes(col, b) (colBytes(col) = (b))
#define colSetOffset(col, o) (colOffset(col) = (o))

// ----------------- TSDB SCHEMA DEFINITION
typedef struct {
H
TD-166  
hzcheng 已提交
48
  int      totalCols;  // Total columns allocated
H
hzcheng 已提交
49
  int      numOfCols;  // Number of columns appended
H
TD-166  
hzcheng 已提交
50 51
  int      tlen;       // maximum length of a SDataRow without the header part
  int      flen;       // First part length in a SDataRow after the header part
H
hzcheng 已提交
52 53 54 55
  STColumn columns[];
} STSchema;

#define schemaNCols(s) ((s)->numOfCols)
H
TD-166  
hzcheng 已提交
56 57 58
#define schemaTotalCols(s) ((s)->totalCols)
#define schemaTLen(s) ((s)->tlen)
#define schemaFLen(s) ((s)->flen)
H
hzcheng 已提交
59 60 61
#define schemaColAt(s, i) ((s)->columns + i)

STSchema *tdNewSchema(int32_t nCols);
H
TD-166  
hzcheng 已提交
62 63
#define   tdFreeSchema(s) tfree((s))
int       tdSchemaAddCol(STSchema *pSchema, int8_t type, int16_t colId, int32_t bytes);
H
hzcheng 已提交
64
STSchema *tdDupSchema(STSchema *pSchema);
H
TD-27  
hzcheng 已提交
65 66 67
int       tdGetSchemaEncodeSize(STSchema *pSchema);
void *    tdEncodeSchema(void *dst, STSchema *pSchema);
STSchema *tdDecodeSchema(void **psrc);
H
hzcheng 已提交
68

H
more  
Hongze Cheng 已提交
69 70
// ----------------- Data row structure

H
hzcheng 已提交
71
/* A data row, the format is like below:
H
TD-166  
hzcheng 已提交
72 73 74 75 76 77 78
 * |<------------------------------------- len ---------------------------------->|
 * |<--Head ->|<---------   flen -------------->|                                 |
 * +----------+---------------------------------+---------------------------------+
 * | int32_t  |                                 |                                 |
 * +----------+---------------------------------+---------------------------------+
 * |   len    |           First part            |             Second part         |
 * +----------+---------------------------------+---------------------------------+
H
more  
Hongze Cheng 已提交
79
 */
H
hzcheng 已提交
80 81
typedef void *SDataRow;

H
TD-166  
hzcheng 已提交
82
#define TD_DATA_ROW_HEAD_SIZE sizeof(int32_t)
H
hzcheng 已提交
83

H
hzcheng 已提交
84
#define dataRowLen(r) (*(int32_t *)(r))
H
TD-166  
hzcheng 已提交
85 86
#define dataRowAt(r, idx) ((char *)(r) + (idx))
#define dataRowTuple(r) dataRowAt(r, TD_DATA_ROW_HEAD_SIZE)
H
TD-34  
hzcheng 已提交
87
#define dataRowKey(r) (*(TSKEY *)(dataRowTuple(r)))
H
hzcheng 已提交
88
#define dataRowSetLen(r, l) (dataRowLen(r) = (l))
H
hzcheng 已提交
89
#define dataRowCpy(dst, r) memcpy((dst), (r), dataRowLen(r))
H
TD-166  
hzcheng 已提交
90
#define dataRowMaxBytesFromSchema(s) ((s)->tlen + TD_DATA_ROW_HEAD_SIZE)
H
hzcheng 已提交
91

H
hzcheng 已提交
92
SDataRow tdNewDataRowFromSchema(STSchema *pSchema);
H
hzcheng 已提交
93
void     tdFreeDataRow(SDataRow row);
H
TD-166  
hzcheng 已提交
94
void     tdInitDataRow(SDataRow row, STSchema *pSchema);
H
TD-166  
hzcheng 已提交
95
int      tdAppendColVal(SDataRow row, void *value, int8_t type, int32_t bytes, int32_t offset);
H
hzcheng 已提交
96
void     tdDataRowReset(SDataRow row, STSchema *pSchema);
H
hzcheng 已提交
97
SDataRow tdDataRowDup(SDataRow row);
H
more  
Hongze Cheng 已提交
98

H
TD-34  
hzcheng 已提交
99 100
// ----------------- Data column structure
typedef struct SDataCol {
H
TD-34  
hzcheng 已提交
101 102 103 104 105
  int8_t  type;
  int16_t colId;
  int     bytes;
  int     len;
  int     offset;
H
TD-100  
hzcheng 已提交
106
  void *  pData; // Original data
H
TD-34  
hzcheng 已提交
107 108
} SDataCol;

H
TD-34  
hzcheng 已提交
109
typedef struct {
H
TD-34  
hzcheng 已提交
110 111 112
  int      maxRowSize;
  int      maxCols;    // max number of columns
  int      maxPoints;  // max number of points
H
TD-166  
hzcheng 已提交
113 114
  int      exColBytes; // extra column bytes to allocate for each column

H
TD-34  
hzcheng 已提交
115
  int      numOfPoints;
H
TD-34  
hzcheng 已提交
116
  int      numOfCols;  // Total number of cols
H
TD-34  
hzcheng 已提交
117
  int      sversion;   // TODO: set sversion
H
TD-34  
hzcheng 已提交
118 119 120 121
  void *   buf;
  SDataCol cols[];
} SDataCols;

H
TD-34  
hzcheng 已提交
122
#define keyCol(pCols) (&((pCols)->cols[0]))  // Key column
H
TD-34  
hzcheng 已提交
123 124 125
#define dataColsKeyAt(pCols, idx) ((int64_t *)(keyCol(pCols)->pData))[(idx)]
#define dataColsKeyFirst(pCols) dataColsKeyAt(pCols, 0)
#define dataColsKeyLast(pCols) dataColsKeyAt(pCols, (pCols)->numOfPoints - 1)
H
TD-34  
hzcheng 已提交
126

H
TD-166  
hzcheng 已提交
127
SDataCols *tdNewDataCols(int maxRowSize, int maxCols, int maxRows, int exColBytes);
H
TD-34  
hzcheng 已提交
128
void       tdResetDataCols(SDataCols *pCols);
H
TD-34  
hzcheng 已提交
129
void       tdInitDataCols(SDataCols *pCols, STSchema *pSchema);
H
TD-100  
hzcheng 已提交
130
SDataCols *tdDupDataCols(SDataCols *pCols, bool keepData);
H
TD-34  
hzcheng 已提交
131
void       tdFreeDataCols(SDataCols *pCols);
H
TD-34  
hzcheng 已提交
132
void       tdAppendDataRowToDataCol(SDataRow row, SDataCols *pCols);
H
TD-34  
hzcheng 已提交
133
void       tdPopDataColsPoints(SDataCols *pCols, int pointsToPop);
H
hzcheng 已提交
134
int        tdMergeDataCols(SDataCols *target, SDataCols *src, int rowsToMerge);
H
TD-100  
hzcheng 已提交
135
void       tdMergeTwoDataCols(SDataCols *target, SDataCols *src1, int *iter1, SDataCols *src2, int *iter2, int tRows);
H
more  
Hongze Cheng 已提交
136

H
more  
hzcheng 已提交
137 138 139 140
#ifdef __cplusplus
}
#endif

H
hzcheng 已提交
141
#endif  // _TD_DATA_FORMAT_H_