Update doc: msgstream

Signed-off-by: GuoRentong <rentong.guo@zilliz.com>
pull/4973/head^2
GuoRentong 2021-01-15 14:02:12 +08:00 committed by yefu.chen
parent 63b21321d6
commit 9038521aa3
5 changed files with 113 additions and 21 deletions

View File

@ -1,9 +1,7 @@
## 8. Message Stream Service
## 8. Message Stream
#### 8.1 Overview
#### 8.2 Message Stream Service API
@ -67,6 +65,14 @@ type DescribeChannelResponse struct {
#### A.3 Message Stream
* Overview
<img src="./figs/msg_stream_input_output.jpeg" width=700>
* Interface
``` go
type MsgType uint32
const {

View File

@ -242,25 +242,75 @@ type IDResponse struct {
#### 10.1 Interfaces (RPC)
#### 10.2 Dd (Data definitions) Channel
| RPC | description |
| :----------------- | ------------------------------------------------------------ |
| CreateCollection | create a collection base on schema statement |
| DropCollection | drop a collection |
| HasCollection | whether or not a collection exists |
| DescribeCollection | show a collection's schema and its descriptive statistics |
| ShowCollections | list all collections |
| CreatePartition | create a partition |
| DropPartition | drop a partition |
| HasPartition | whether or not a partition exists |
| DescribePartition | show a partition's name and its descriptive statistics |
| ShowPartitions | list a collection's all partitions |
| AllocTimestamp | allocate a batch of consecutive timestamps |
| AllocID | allocate a batch of consecutive IDs |
| AssignSegmentID | assign segment id to insert rows (master determines which segment these rows belong to) |
| GetSysConfigs | get system configurations |
| | |
* *CreateCollection*
```go
type CreateCollectionRequest struct {
RequestBase
DbName string
CollectionName string
DbID UniqueID
CollectionID UniqueID
Schema []bytes
}
```
* *DropCollection*
```go
type DropCollectionRequest struct {
RequestBase
DbName string
CollectionName string
DbID UniqueID
CollectionID UniqueID
}
```
* *CreatePartition*
```go
type CreatePartitionRequest struct {
RequestBase
DbName string
CollectionName string
PartitionName string
DbID UniqueID
CollectionID UniqueID
PartitionID UniqueID
}
```
* *DropPartition*
```go
type DropPartitionRequest struct {
RequestBase
DbName string
CollectionName string
PartitionName string
DbID UniqueID
CollectionID UniqueID
PartitionID UniqueID
}
```
* *CreateIndex*
```go
type CreateIndexRequest struct {
RequestBase
DbName string
CollectionName string
FieldName string
DbID UniqueID
CollectionID UniqueID
FieldID int64
Params [] KeyValuePair
}
```

View File

@ -168,6 +168,24 @@ type CreateQueryChannelResponse struct {
#### 8.2 Query Channel
```go
type SearchRequest struct {
RequestBase
DbName string
CollectionName string
PartitionNames []string
DbID UniqueID
CollectionID UniqueID
PartitionIDs []UniqueID
Dsl string
PlaceholderGroup []byte
}
```
#### 8.2 Query Node Interface
```go

View File

@ -163,6 +163,24 @@ type InsertChannelRequest struct {
#### 8.2 Insert Channel
```go
type InsertRequest struct {
RequestBase
DbName string
CollectionName string
PartitionName string
DbID UniqueID
CollectionID UniqueID
PartitionID UniqueID
RowData []Blob
HashKeys []uint32
}
```
#### 8.2 Data Node Interface
```go

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 MiB