Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
search_sort_field.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/*
3 * Copyright 2023-Present Couchbase, Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#pragma once
19
24
25#include <string>
26
27namespace couchbase
28{
37{
38public:
39 explicit search_sort_field(std::string field)
40 : field_{ std::move(field) }
41 {
42 }
43
44 search_sort_field(std::string field, bool descending)
46 , field_{ std::move(field) }
47 {
48 }
49
59 auto descending(bool desc) -> search_sort_field&;
60
75
92
108
115 [[nodiscard]] auto encode() const -> encoded_search_sort override;
116
117private:
118 std::string field_;
119 std::optional<search_sort_field_type> type_{};
120 std::optional<search_sort_field_mode> mode_{};
121 std::optional<search_sort_field_missing> missing_{};
122};
123} // namespace couchbase
Sorts by a field in the hits.
Definition search_sort_field.hxx:37
auto encode() const -> encoded_search_sort override
auto mode(search_sort_field_mode value) -> search_sort_field &
Specifies the search-order for index-fields that contain multiple values (in consequence of arrays or...
search_sort_field(std::string field)
Definition search_sort_field.hxx:39
auto missing(search_sort_field_missing value) -> search_sort_field &
Specifies the sort-procedure for documents with a missing value in a field specified for sorting.
search_sort_field(std::string field, bool descending)
Definition search_sort_field.hxx:44
auto descending(bool desc) -> search_sort_field &
Set the sorting direction.
auto type(search_sort_field_type value) -> search_sort_field &
Specifies the type of the search-order field value.
Base class for full text sort objects of search queries.
Definition search_sort.hxx:36
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
search_sort_field_mode
Definition search_sort_field_mode.hxx:22
search_sort_field_type
Definition search_sort_field_type.hxx:22
search_sort_field_missing
Definition search_sort_field_missing.hxx:22