package couchbase.search.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc SearchQuery (SearchQueryRequest, stream SearchQueryResponse)

  search.proto:250

  message SearchQueryRequest

  search.proto:253

  • string index_name = 1

  • optional Query query = 2

  • SearchQueryRequest.ScanConsistency scan_consistency = 3

  • uint32 limit = 4

  • uint32 skip = 5

  • bool include_explanation = 6

  • SearchQueryRequest.HighlightStyle highlight_style = 7

  • repeated string highlight_fields = 8

  • repeated string fields = 9

  • repeated Sorting sort = 10

  • bool disable_scoring = 11

  • repeated string collections = 12

  • bool include_locations = 13

  • map<string, Facet> facets = 14

  • optional string bucket_name = 15

  • optional string scope_name = 16

  message SearchQueryResponse

  search.proto:281

  • repeated SearchQueryResponse.SearchQueryRow hits = 1

  • map<string, SearchQueryResponse.FacetResult> facets = 2

  • optional SearchQueryResponse.MetaData meta_data = 3

Used in: Query

• optional float boost = 1

• optional string field = 2

• bool value = 6

Used in: Query

• optional float boost = 1

• optional ConjunctionQuery must = 2

• optional DisjunctionQuery must_not = 3

• optional DisjunctionQuery should = 4

Used in: BooleanQuery, Query

• optional float boost = 1

• repeated Query queries = 2

Used in: DateRangeFacet

• string name = 1

• optional string start = 2

• optional string end = 3

Used in: Facet

• string field = 1

• uint32 size = 2

• repeated DateRange date_ranges = 3

Used in: Query

• optional float boost = 1

• optional string field = 2

• optional string date_time_parser = 3

• optional string start_date = 4

• optional string end_date = 5

Used in: BooleanQuery, Query

• optional float boost = 1

• repeated Query queries = 2

• optional uint32 minimum = 3

Used in: Query

• optional float boost = 1

• repeated string ids = 3

Used in: SearchQueryRequest

• oneof facet

  • DateRangeFacet date_range_facet = 1

  • NumericRangeFacet numeric_range_facet = 2

  • TermFacet term_facet = 3

Used in: Sorting

• string field = 1

• bool descending = 2

• string missing = 3

• string mode = 4

• string type = 5

Used in: Query

• optional float boost = 1

• optional string field = 2

• optional LatLng top_left = 3

• optional LatLng bottom_right = 4

Used in: Query

• optional float boost = 1

• optional string field = 2

• optional LatLng center = 3

• string distance = 4

Used in: Sorting

• string field = 1

• bool descending = 2

• optional LatLng center = 3

• string unit = 4

Used in: Query

• optional float boost = 1

• optional string field = 2

• repeated LatLng vertices = 3

Used in: Sorting

• bool descending = 1

Used in: GeoBoundingBoxQuery, GeoDistanceQuery, GeoDistanceSorting, GeoPolygonQuery

• double latitude = 1

• double longitude = 2

Used in: Query

(message has no fields)

Used in: Query

(message has no fields)

Used in: Query

• optional float boost = 1

• optional string field = 2

• string phrase = 3

• optional string analyzer = 4

Used in: Query

• optional float boost = 1

• optional string field = 2

• string value = 3

• optional string analyzer = 4

• optional uint64 fuzziness = 5

• optional MatchQuery.Operator operator = 6

• optional uint64 prefix_length = 7

Used in: MatchQuery

• OPERATOR_OR = 0

• OPERATOR_AND = 1

Used in: NumericRangeFacet

• string name = 1

• optional float min = 2

• optional float max = 3

Used in: Facet

• string field = 1

• uint32 size = 2

• repeated NumericRange numeric_ranges = 3

Used in: Query

• optional float boost = 1

• optional string field = 2

• optional float min = 3

• optional float max = 4

• optional bool inclusive_min = 5

• optional bool inclusive_max = 6

Used in: Query

• optional float boost = 1

• optional string field = 2

• repeated string terms = 3

Used in: Query

• optional float boost = 1

• optional string field = 2

• string prefix = 3

Used in: ConjunctionQuery, DisjunctionQuery, SearchQueryRequest

• oneof query

  • BooleanFieldQuery boolean_field_query = 1

  • BooleanQuery boolean_query = 2

  • ConjunctionQuery conjunction_query = 3

  • DateRangeQuery date_range_query = 4

  • DisjunctionQuery disjunction_query = 5

  • DocIdQuery doc_id_query = 6

  • GeoBoundingBoxQuery geo_bounding_box_query = 7

  • GeoDistanceQuery geo_distance_query = 8

  • GeoPolygonQuery geo_polygon_query = 9

  • MatchAllQuery match_all_query = 10

  • MatchNoneQuery match_none_query = 11

  • MatchPhraseQuery match_phrase_query = 12

  • MatchQuery match_query = 13

  • NumericRangeQuery numeric_range_query = 14

  • PhraseQuery phrase_query = 15

  • PrefixQuery prefix_query = 16

  • QueryStringQuery query_string_query = 17

  • RegexpQuery regexp_query = 18

  • TermQuery term_query = 19

  • TermRangeQuery term_range_query = 20

  • WildcardQuery wildcard_query = 21

Used in: Query

• optional float boost = 1

• string query_string = 3

Used in: Query

• optional float boost = 1

• optional string field = 2

• string regexp = 3

Used in: Sorting

• bool descending = 1

Used in: SearchQueryRequest

• HIGHLIGHT_STYLE_DEFAULT = 0

• HIGHLIGHT_STYLE_HTML = 1

• HIGHLIGHT_STYLE_ANSI = 2

Used in: SearchQueryRequest

• SCAN_CONSISTENCY_NOT_BOUNDED = 0

Used in: FacetResult

• string field = 2

• int64 total = 3

• int64 missing = 4

• int64 other = 5

• repeated DateRangeResult date_ranges = 6

Used in: DateRangeFacetResult

• string name = 1

• uint64 size = 2

• optional google.protobuf.Timestamp start = 3

• optional google.protobuf.Timestamp end = 4

Used in: SearchQueryResponse

• oneof search_facet

  • TermFacetResult term_facet = 1

  • DateRangeFacetResult date_range_facet = 2

  • NumericRangeFacetResult numeric_range_facet = 3

Used in: SearchQueryRow

• repeated string content = 1

Used in: SearchQueryRow

• string field = 1

• string term = 2

• uint32 position = 3

• uint32 start = 4

• uint32 end = 5

• repeated uint32 array_positions = 6

Used in: SearchQueryResponse

• optional SearchMetrics metrics = 1

• map<string, string> errors = 2

Used in: FacetResult

• string field = 2

• int64 total = 3

• int64 missing = 4

• int64 other = 5

• repeated NumericRangeResult numeric_ranges = 6

Used in: NumericRangeFacetResult

• string name = 1

• uint64 size = 2

• uint64 min = 3

• uint64 max = 4

Used in: MetaData

• optional google.protobuf.Duration execution_time = 1

• uint64 total_rows = 2

• double max_score = 3

• uint64 total_partition_count = 4

• uint64 success_partition_count = 5

• uint64 error_partition_count = 6

Used in: SearchQueryResponse

• string id = 1

• double score = 2

• string index = 3

• bytes explanation = 4

• repeated Location locations = 5

• map<string, Fragment> fragments = 6

• map<string, bytes> fields = 7

Used in: FacetResult

• string field = 2

• int64 total = 3

• int64 missing = 4

• int64 other = 5

• repeated TermResult terms = 6

Used in: TermFacetResult

• string name = 1

• string field = 2

• uint64 size = 3

Used in: SearchQueryRequest

• oneof sorting

  • FieldSorting field_sorting = 1

  • GeoDistanceSorting geo_distance_sorting = 2

  • IdSorting id_sorting = 3

  • ScoreSorting score_sorting = 4

Used in: Facet

• string field = 1

• uint32 size = 2

Used in: Query

• optional float boost = 1

• optional string field = 2

• string term = 3

• optional uint64 fuzziness = 4

• optional uint64 prefix_length = 5

Used in: Query

• optional float boost = 1

• optional string field = 2

• optional string min = 5

• optional string max = 6

• optional bool inclusive_min = 7

• optional bool inclusive_max = 8

Used in: Query

• optional float boost = 1

• optional string field = 2

• string wildcard = 3