A search query which allows to match inside a geo polygon.
More...
#include <couchbase/geo_polygon_query.hxx>
|
| geo_polygon_query (std::vector< geo_point > points) |
| Create a new geo polygon query.
|
|
auto | field (std::string field_name) -> geo_polygon_query & |
| If a field is specified, only terms in that field will be matched.
|
|
auto | encode () const -> encoded_search_query override |
|
virtual | ~search_query ()=default |
|
template<typename derived_query = search_query, std::enable_if_t< std::is_base_of_v< search_query, derived_query >, bool > = true> |
auto | boost (double boost) -> derived_query & |
| The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1) or decrease the relative weight (with a boost between 0 and 1).
|
|
A search query which allows to match inside a geo polygon.
If a target data-location falls within the box, its document is returned.
- See also
- https://docs.couchbase.com/server/current/fts/fts-supported-queries-geo-bounded-polygon.html server documentation
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ geo_polygon_query()
Create a new geo polygon query.
- Parameters
-
points | the points specifying corners of geo polygon. |
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ encode()
auto encode |
( |
| ) |
const -> encoded_search_query |
|
nodiscardoverridevirtual |
- Returns
- encoded representation of the query.
- Since
- 1.0.0
- Internal
- Internal interface
Implements search_query.
◆ field()
If a field is specified, only terms in that field will be matched.
- Parameters
-
field_name | name of the field to be matched |
- Returns
- this query for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
The documentation for this class was generated from the following file: