diff --git a/docs/design_docs/milvus_create_collection_en.md b/docs/design_docs/milvus_create_collection_en.md index 4f56572ab5..1d4cd3dc81 100644 --- a/docs/design_docs/milvus_create_collection_en.md +++ b/docs/design_docs/milvus_create_collection_en.md @@ -41,7 +41,7 @@ message CollectionSchema { ``` -1. When received the `CreateCollection` request, the `Proxy` would wrap this request into `CreateCollectionTask`, and pushes this task into `DdTaskQueue` queue. After that, `Proxy` would call `WaitToFinish` method to wait until the task is finished. +2. When received the `CreateCollection` request, the `Proxy` would wrap this request into `CreateCollectionTask`, and pushes this task into `DdTaskQueue` queue. After that, `Proxy` would call `WaitToFinish` method to wait until the task is finished. ```go type task interface { @@ -71,7 +71,7 @@ type createCollectionTask struct { } ``` -2. There is a background service in `Proxy`, this service would get the `CreateCollectionTask` from `DdTaskQueue`, and execute it in three phases. +3. There is a background service in `Proxy`, this service would get the `CreateCollectionTask` from `DdTaskQueue`, and execute it in three phases. - `PreExecute`, do some static checking at this phase, such as check if `Collection Name` and `Field Name` are legal, if there are duplicate columns, etc. - `Execute`, at this phase, `Proxy` would send `CreateCollection` request to `RootCoord` via `Grpc`, and wait for response, the `proto` is defined as follows: @@ -88,7 +88,7 @@ type createCollectionTask struct { - `PostExecute`, `CreateCollectonTask` does nothing at this phase, and return directly. -3. `RootCoord` would wrap the `CreateCollection` request into `CreateCollectionReqTask`, and then call function `executeTask`. `executeTask` would return until the `context` is done or `CreateCollectionReqTask.Execute` is returned. +4. `RootCoord` would wrap the `CreateCollection` request into `CreateCollectionReqTask`, and then call function `executeTask`. `executeTask` would return until the `context` is done or `CreateCollectionReqTask.Execute` is returned. ```go type reqTask interface { @@ -104,13 +104,13 @@ type CreateCollectionReqTask struct { } ``` -4. `CreateCollectionReqTask.Execute` would alloc `CollecitonID` and default `PartitionID`, and set `Virtual Channel` and `Physical Channel`, which are used by `MsgStream`, then write the `Collection`'s meta into `metaTable` +5. `CreateCollectionReqTask.Execute` would alloc `CollecitonID` and default `PartitionID`, and set `Virtual Channel` and `Physical Channel`, which are used by `MsgStream`, then write the `Collection`'s meta into `metaTable` -5. After `Collection`'s meta written into `metaTable`, `Milvus` would consider this collection has been created successfully. +6. After `Collection`'s meta written into `metaTable`, `Milvus` would consider this collection has been created successfully. -6. `RootCoord` would alloc a timestamp from `TSO` before writing `Collection`'s meta into `metaTable`, and this timestamp is considered as the point when the collection was created +7. `RootCoord` would alloc a timestamp from `TSO` before writing `Collection`'s meta into `metaTable`, and this timestamp is considered as the point when the collection was created -7. At last `RootCoord` will send a message of `CreateCollectionRequest` into `MsgStream`, and other components, who have subscribed to the `MsgStream`, would be notified. The `Proto` of `CreateCollectionRequest` is defined as follow: +8. At last `RootCoord` will send a message of `CreateCollectionRequest` into `MsgStream`, and other components, who have subscribed to the `MsgStream`, would be notified. The `Proto` of `CreateCollectionRequest` is defined as follow: ```proto message CreateCollectionRequest { @@ -129,7 +129,7 @@ message CreateCollectionRequest { ``` -8. After all these operations, `RootCoord` would update the internal timestamp and return, so the `Proxy` would get the response. +9. After all these operations, `RootCoord` would update the internal timestamp and return, so the `Proxy` would get the response. _Notes:_