package search

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Search (SearchRequest, stream StreamSearchResults)

  search.proto:17

  external rpcs, for rpc clients

  message SearchRequest

  search.proto:88

  • bytes Contents = 1

  • string IndexName = 2

  • string IndexUUID = 3

  • bool Stream = 4

  • bytes QueryCtlParams = 5

  • bytes QueryPIndexes = 6

  message StreamSearchResults

  search.proto:103

  A stream SearchResult describes the streaming results of executing a SearchRequest.

  • oneof Contents

    • StreamSearchResults.Batch Hits = 1

    • bytes SearchResult = 2

• rpc Check (HealthCheckRequest, HealthCheckResponse)

  search.proto:19

  message HealthCheckRequest

  search.proto:24

  • string service = 1

  message HealthCheckResponse

  search.proto:28

  • HealthCheckResponse.ServingStatus status = 1

• rpc DocCount (DocCountRequest, DocCountResult)

  search.proto:21

  message DocCountRequest

  search.proto:37

  • string IndexName = 1

  • string IndexUUID = 2

  message DocCountResult

  search.proto:42

  • int64 DocCount = 1

ConsistencyParams represent the consistency requirements of a client's request.

Used in: QueryCtl

• string Level = 1

  A Level value of "" means stale is ok; "at_plus" means we need consistency at least at or beyond the consistency vector but not before.

• map<string, ConsistencyVectors> Vectors = 2

  Keyed by indexName.

• string Results = 3

Key is partition or partition/partitionUUID. Value is seq. For example, a DCP data source might have the key as either "vbucketId" or "vbucketId/vbucketUUID".

Used in: ConsistencyParams

• map<string, uint64> ConsistencyVector = 1

Used in: HealthCheckResponse

• UNKNOWN = 0

• SERVING = 1

• NOT_SERVING = 2

QueryCtl defines the JSON parameters that control query execution and which are independent of any specific pindex type.

Used in: QueryCtlParams

• int64 Timeout = 1

• optional ConsistencyParams Consistency = 2

• string PartitionSelection = 3

QueryCtlParams defines the JSON that includes the "ctl" part of a query request. These "ctl" query request parameters are independent of any specific pindex type.

• optional QueryCtl Ctl = 1

• repeated string PIndexNames = 1

  An empty or nil PIndexNames means the query should use all the pindexes of the index.

• bytes Contents = 1

Used in: StreamSearchResults

• bytes Bytes = 1

• repeated uint64 Offsets = 2

• uint64 Total = 3