[skip e2e] Add note for design doc (#13844)

Signed-off-by: yhmo <yihua.mo@zilliz.com>
This commit is contained in:
groot 2021-12-21 11:09:08 +08:00 committed by GitHub
parent 9d8c24f4a4
commit 9448629439
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,12 +4,12 @@
- `Segment`: The memory structure of storing a piece of data which supports concurrent insertion, deletion, query, index loading, monitoring and statistics
- `Schema`: Definition of collection data format, including
- `vector<FieldMeta>`: Order list of FieldMeta
- `isAutoId`: If set to True , the default primary field is `RowId` and it is auto generated
- `isAutoId`: If set to True , the default primary field is `RowId` and it is auto-generated
- `primaryKey`: (When `isAutoId = False`) Specify primary key field
- `FieldMeta`: Field properties, including
- `DataType`: Data type, including Int8...Int64, Float, Double, FloatVector, BinaryVector and String later
- `Dim`: (When dataType is vector) Type vector dimension
- `metric_type`: (When dataType is vector type, optional) The metric type corresponding to this vector is related to the small batch index and can be empty
- `metric_type`: (When dataType is vector type, optional) The metric type corresponding to this vector is related to the small-batch index and can be empty
- `FieldName`: Column name
- `FieldId`: Unique number of the column
- (hidden) `FieldOffset`: Which is the subscript of `vector<Field>` in the schema. The internal calculation of segcore is basically based on field offset