milvus-io
/
milvus
mirror of https://github.com/milvus-io/milvus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[skip ci]Add segment_overview in segcore doc (#8198) 

Signed-off-by: xiaofan-luan <xiaofan.luan@zilliz.com>
pull/8242/head
Xiaofan 2021-09-18 18:13:52 +08:00 committed by GitHub
parent 223044a7ca
commit 55cf1088f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/design_docs/segcore/segment_overview.md Normal file
View File

@ -0,0 +1,25 @@
# Segment Overview
There are currently two types of Segment
1. Growing segment, dynamic insert is allowed, but can not load index for fast retriving
2. Sealed segment, dynamic insert is disabled, load vector index is supported
Both Segment types share the same interface, based on `SegmentInterface`, External callers only need to care about the behaviour of the following interface as function declarations and corresponding constructor:
1. `SegmentInterface`
2. `SegmentGrowing` & `CreateGrowingSegment`
3. `SegmentSealed` & `CreateSealedSegment`
Other internal functions and are hidden as implementation details in the following classes:
1. `SegmentInternalInterface`
2. `SegmentGrowingImpl`
3. `SegmentSealedImpl`
In principle, the reusable code logic of growing / sealed is written into the 'SegmentInternalInterface' as far as possible, The different part of two classes contain more different parts
See more details about segments at:
1. [segment_interface.md](segment_interface.md)
2. [segment_growing.md](segment_growing.md)
3. [segment_sealed.md](segment_sealed.md)