Loading...
Searching...
No Matches
distinct.hpp
Go to the documentation of this file.
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#pragma once
#include <mongocxx/options/distinct-fwd.hpp> // IWYU pragma: export
//
#include <mongocxx/v1/distinct_options.hpp> // IWYU pragma: export
#include <chrono>
#include <cstdint> // IWYU pragma: keep: backward compatibility, to be removed.
#include <string> // IWYU pragma: keep: backward compatibility, to be removed.
#include <utility>
#include <bsoncxx/document/value.hpp>
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/types/bson_value/value.hpp>
#include <bsoncxx/types/bson_value/view.hpp>
#include <bsoncxx/types/bson_value/view_or_value.hpp>
#include <mongocxx/read_concern.hpp>
#include <mongocxx/read_preference.hpp>
#include <mongocxx/config/prelude.hpp>
namespace mongocxx {
namespace v_noabi {
namespace options {
class distinct {
public:
distinct() = default;
/* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE() distinct(v1::distinct_options opts);
explicit operator v1::distinct_options() const {
using bsoncxx::v_noabi::to_v1;
v1::distinct_options ret;
if (_collation) {
ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
}
if (_max_time) {
ret.max_time(*_max_time);
}
if (_comment) {
ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
}
if (_read_preference) {
ret.read_preference(to_v1(*_read_preference));
}
if (_read_concern) {
ret.read_concern(to_v1(*_read_concern));
}
return ret;
}
distinct& collation(bsoncxx::v_noabi::document::view_or_value collation) {
_collation = std::move(collation);
return *this;
}
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const& collation() const {
return _collation;
}
distinct& max_time(std::chrono::milliseconds max_time) {
_max_time = max_time;
return *this;
}
bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> const& max_time() const {
return _max_time;
}
distinct& comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment) {
_comment = std::move(comment);
return *this;
}
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> const& comment() const {
return _comment;
}
distinct& read_preference(v_noabi::read_preference rp) {
_read_preference = std::move(rp);
return *this;
}
bsoncxx::v_noabi::stdx::optional<v_noabi::read_preference> const& read_preference() const {
return _read_preference;
}
distinct& read_concern(v_noabi::read_concern rc) {
_read_concern = std::move(rc);
return *this;
}
bsoncxx::v_noabi::stdx::optional<v_noabi::read_concern> const& read_concern() const {
return _read_concern;
}
private:
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> _max_time;
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
bsoncxx::v_noabi::stdx::optional<v_noabi::read_preference> _read_preference;
bsoncxx::v_noabi::stdx::optional<v_noabi::read_concern> _read_concern;
};
} // namespace options
} // namespace v_noabi
} // namespace mongocxx
namespace mongocxx {
namespace v_noabi {
inline v_noabi::options::distinct from_v1(v1::distinct_options v) {
return {std::move(v)};
}
inline v1::distinct_options to_v1(v_noabi::options::distinct const& v) {
return v1::distinct_options{v};
}
} // namespace v_noabi
} // namespace mongocxx
#include <mongocxx/config/postlude.hpp>
bsoncxx::v1::document::value
A BSON document.
Definition value.hpp:44
bsoncxx::v1::stdx::optional
A polyfill for std::optional<T>.
Definition optional.hpp:799
bsoncxx::v1::types::value
A union of BSON type values.
Definition value.hpp:52
mongocxx::options::distinct::distinct
distinct()=default
Default initialization.
mongocxx::v1::distinct_options
Options for a "distinct" command.
Definition distinct_options.hpp:53
mongocxx::v1::distinct_options::comment
distinct_options & comment(bsoncxx::v1::types::value v)
Set the "comment" field.
mongocxx::v1::distinct_options::read_preference
distinct_options & read_preference(v1::read_preference v)
Set the "readPreference" field.
mongocxx::v1::distinct_options::max_time
distinct_options & max_time(std::chrono::milliseconds v)
Set the "maxTimeMS" field.
mongocxx::v1::distinct_options::collation
distinct_options & collation(bsoncxx::v1::document::value v)
Set the "collation" field.
mongocxx::v1::distinct_options::read_concern
distinct_options & read_concern(v1::read_concern v)
Set the "readConcern" field.
mongocxx::v_noabi::options::distinct
Used by mongocxx::v_noabi::collection.
Definition distinct.hpp:48
mongocxx::v_noabi::options::distinct::read_preference
bsoncxx::v_noabi::stdx::optional< v_noabi::read_preference > const & read_preference() const
The current read_preference for this operation.
Definition distinct.hpp:208
mongocxx::v_noabi::options::distinct::comment
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > const & comment() const
The current comment for this operation.
Definition distinct.hpp:178
mongocxx::v_noabi::options::distinct::read_concern
bsoncxx::v_noabi::stdx::optional< v_noabi::read_concern > const & read_concern() const
The current read_concern for this operation.
Definition distinct.hpp:238
mongocxx::v_noabi::options::distinct::read_preference
distinct & read_preference(v_noabi::read_preference rp)
Sets the read_preference for this operation.
Definition distinct.hpp:195
mongocxx::v_noabi::options::distinct::collation
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
Definition distinct.hpp:118
mongocxx::v_noabi::options::distinct::distinct
distinct()=default
Default initialization.
mongocxx::v_noabi::options::distinct::distinct_options
operator v1::distinct_options() const
Convert to the mongocxx::v1 equivalent.
Definition distinct.hpp:63
mongocxx::v_noabi::options::distinct::collation
distinct & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition distinct.hpp:104
mongocxx::v_noabi::options::distinct::read_concern
distinct & read_concern(v_noabi::read_concern rc)
Sets the read_concern for this operation.
Definition distinct.hpp:225
mongocxx::v_noabi::options::distinct::max_time
distinct & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
Definition distinct.hpp:135
mongocxx::v_noabi::options::distinct::max_time
bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > const & max_time() const
The current max_time setting.
Definition distinct.hpp:148
mongocxx::v_noabi::options::distinct::comment
distinct & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Sets the comment for this operation.
Definition distinct.hpp:165
mongocxx::v_noabi::read_concern
Controls the consistency and isolation properties of data read from replica sets and sharded clusters...
Definition read_concern.hpp:54
mongocxx::v_noabi::read_preference
Describes how MongoDB clients route read operations to the members of a replica set or sharded cluste...
Definition read_preference.hpp:59
distinct-fwd.hpp
Declares mongocxx::v_noabi::options::distinct.
distinct_options.hpp
Provides mongocxx::v1::distinct_options.
view_or_value.hpp
Provides bsoncxx::v_noabi::document::view_or_value.
MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE
#define MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(...)
Equivalent to MONGOCXX_ABI_EXPORT_UNSTABLE with MONGOCXX_ABI_CDECL.
Definition config.hpp:28
postlude.hpp
The mongocxx v_noabi macro guard postlude header.
prelude.hpp
The mongocxx v_noabi macro guard prelude header.
bsoncxx::v_noabi::document::view_or_value
v_noabi::view_or_value< v_noabi::document::view, v_noabi::document::value > view_or_value
Equivalent to v_noabi::view_or_value<v_noabi::document::view, v_noabi::document::value>.
Definition view_or_value.hpp:30
bsoncxx::v_noabi::types::bson_value::view_or_value
v_noabi::view_or_value< view, value > view_or_value
Equivalent to v_noabi::view_or_value<view, value>.
Definition view_or_value.hpp:31
bsoncxx::v_noabi::to_v1
v1::element::view to_v1(v_noabi::array::element const &v)
Convert to the bsoncxx::v1 equivalent of v.
Definition element.hpp:132
mongocxx::v1
Declares entities whose ABI stability is guaranteed for documented symbols.
mongocxx::v_noabi::options
Declares entities representing options to use with various commands.
mongocxx::v_noabi
Declares entities whose ABI stability is NOT guaranteed.
mongocxx::v_noabi::to_v1
v1::bulk_write to_v1(v_noabi::bulk_write v)
Convert to the mongocxx::v1 equivalent of v.
Definition bulk_write.hpp:162
mongocxx::v_noabi::from_v1
v_noabi::bulk_write from_v1(v1::bulk_write v)
Convert to the mongocxx::v_noabi equivalent of v.
Definition bulk_write.hpp:155
mongocxx
The top-level namespace within which all mongocxx library entities are declared.
view_or_value.hpp
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
value.hpp
Provides bsoncxx::v_noabi::document::value.
view.hpp
Provides bsoncxx::v_noabi::document::view.
optional.hpp
Provides std::optional-related polyfills for library API usage.
value.hpp
Provides bsoncxx::v_noabi::types::bson_value::value.
view.hpp
Provides bsoncxx::v_noabi::types::bson_value::view.
read_concern.hpp
Provides mongocxx::v_noabi::read_concern.
read_preference.hpp
Provides mongocxx::v_noabi::read_preference.