Loading...
Searching...
No Matches
count.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/count-fwd.hpp> // IWYU pragma: export
//
#include <bsoncxx/v1/document/value.hpp>
#include <bsoncxx/v1/types/value.hpp>
#include <mongocxx/v1/count_options.hpp> // IWYU pragma: export
#include <chrono>
#include <cstdint>
#include <string> // IWYU pragma: keep: backward compatibility, to be removed.
#include <utility>
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/types/bson_value/view.hpp>
#include <bsoncxx/types/bson_value/view_or_value.hpp>
#include <mongocxx/hint.hpp>
#include <mongocxx/read_concern.hpp>
#include <mongocxx/read_preference.hpp>
#include <mongocxx/config/prelude.hpp>
namespace mongocxx {
namespace v_noabi {
namespace options {
class count {
public:
count() = default;
/* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE() count(v1::count_options opts);
explicit operator v1::count_options() const {
using bsoncxx::v_noabi::to_v1;
using mongocxx::v_noabi::to_v1;
v1::count_options ret;
if (_collation) {
ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
}
if (_hint) {
ret.hint(to_v1(*_hint));
}
if (_comment) {
ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
}
if (_limit) {
ret.limit(*_limit);
}
if (_max_time) {
ret.max_time(*_max_time);
}
if (_skip) {
ret.skip(*_skip);
}
if (_read_preference) {
ret.read_preference(to_v1(*_read_preference));
}
if (_read_concern) {
ret.read_concern(to_v1(*_read_concern));
}
return ret;
}
count& 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;
}
count& hint(v_noabi::hint index_hint) {
_hint = std::move(index_hint);
return *this;
}
bsoncxx::v_noabi::stdx::optional<v_noabi::hint> const& hint() const {
return _hint;
}
count& 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;
}
count& limit(std::int64_t limit) {
_limit = limit;
return *this;
}
bsoncxx::v_noabi::stdx::optional<std::int64_t> const& limit() const {
return _limit;
}
count& 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;
}
count& skip(std::int64_t skip) {
_skip = skip;
return *this;
}
bsoncxx::v_noabi::stdx::optional<std::int64_t> const& skip() const {
return _skip;
}
count& 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;
}
count& 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<v_noabi::hint> _hint;
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
bsoncxx::v_noabi::stdx::optional<std::int64_t> _limit;
bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> _max_time;
bsoncxx::v_noabi::stdx::optional<std::int64_t> _skip;
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::count from_v1(v1::count_options v) {
return {std::move(v)};
}
inline v1::count_options to_v1(v_noabi::options::count const& v) {
return v1::count_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::count::count
count()=default
Default initialization.
mongocxx::v1::count_options
Options for a "countDocuments" operation.
Definition count_options.hpp:58
mongocxx::v1::count_options::skip
count_options & skip(std::int64_t v)
Set the "skip" field.
mongocxx::v1::count_options::comment
count_options & comment(bsoncxx::v1::types::value v)
Set the "comment" field.
mongocxx::v1::count_options::read_preference
count_options & read_preference(v1::read_preference v)
Set the "readPreference" field.
mongocxx::v1::count_options::limit
count_options & limit(std::int64_t v)
Set the "limit" field.
mongocxx::v1::count_options::read_concern
count_options & read_concern(v1::read_concern v)
Set the "readConcern" field.
mongocxx::v1::count_options::collation
count_options & collation(bsoncxx::v1::document::value v)
Set the "collation" field.
mongocxx::v1::count_options::max_time
count_options & max_time(std::chrono::milliseconds v)
Set the "maxTimeMS" field.
mongocxx::v1::count_options::hint
count_options & hint(v1::hint v)
Set the "hint" field.
mongocxx::v_noabi::hint
The index to "hint" or force a MongoDB server to use when performing a query.
Definition hint.hpp:42
mongocxx::v_noabi::options::count
Used by mongocxx::v_noabi::collection::count_documents.
Definition count.hpp:50
mongocxx::v_noabi::options::count::read_preference
bsoncxx::v_noabi::stdx::optional< v_noabi::read_preference > const & read_preference() const
The current read_preference for this operation.
Definition count.hpp:313
mongocxx::v_noabi::options::count::collation
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
Definition count.hpp:133
mongocxx::v_noabi::options::count::read_preference
count & read_preference(v_noabi::read_preference rp)
Sets the read_preference for this operation.
Definition count.hpp:300
mongocxx::v_noabi::options::count::read_concern
bsoncxx::v_noabi::stdx::optional< v_noabi::read_concern > const & read_concern() const
The current read_concern for this operation.
Definition count.hpp:344
mongocxx::v_noabi::options::count::skip
count & skip(std::int64_t skip)
Sets the number of documents to skip before counting documents.
Definition count.hpp:270
mongocxx::v_noabi::options::count::max_time
count & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
Definition count.hpp:240
mongocxx::v_noabi::options::count::limit
count & limit(std::int64_t limit)
Sets the maximum number of documents to count.
Definition count.hpp:210
mongocxx::v_noabi::options::count::max_time
bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > const & max_time() const
The current max_time setting.
Definition count.hpp:253
mongocxx::v_noabi::options::count::count
count()=default
Default initialization.
mongocxx::v_noabi::options::count::limit
bsoncxx::v_noabi::stdx::optional< std::int64_t > const & limit() const
Gets the current limit.
Definition count.hpp:223
mongocxx::v_noabi::options::count::comment
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > const & comment() const
Gets the current value of the comment option.
Definition count.hpp:193
mongocxx::v_noabi::options::count::comment
count & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition count.hpp:180
mongocxx::v_noabi::options::count::hint
count & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition count.hpp:150
mongocxx::v_noabi::options::count::hint
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition count.hpp:163
mongocxx::v_noabi::options::count::count_options
operator v1::count_options() const
Convert to the mongocxx::v1 equivalent.
Definition count.hpp:65
mongocxx::v_noabi::options::count::skip
bsoncxx::v_noabi::stdx::optional< std::int64_t > const & skip() const
Gets the current number of documents to skip.
Definition count.hpp:283
mongocxx::v_noabi::options::count::read_concern
count & read_concern(v_noabi::read_concern rc)
Sets the read_concern for this operation.
Definition count.hpp:330
mongocxx::v_noabi::options::count::collation
count & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition count.hpp:119
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
count-fwd.hpp
Declares mongocxx::v_noabi::options::count.
count_options.hpp
Provides mongocxx::v1::count_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::v1::document::value.
value.hpp
Provides bsoncxx::v1::types::value.
view.hpp
Provides bsoncxx::v_noabi::document::view.
optional.hpp
Provides std::optional-related polyfills for library API usage.
view.hpp
Provides bsoncxx::v_noabi::types::bson_value::view.
hint.hpp
Provides mongocxx::v_noabi::hint.
read_concern.hpp
Provides mongocxx::v_noabi::read_concern.
read_preference.hpp
Provides mongocxx::v_noabi::read_preference.