Loading...
Searching...
No Matches
find_one_and_replace.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/find_one_and_replace-fwd.hpp> // IWYU pragma: export
//
#include <bsoncxx/v1/document/value.hpp>
#include <bsoncxx/v1/types/value.hpp>
#include <mongocxx/v1/find_one_and_replace_options.hpp> // IWYU pragma: export
#include <chrono>
#include <cstdint> // 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/options/find_one_common_options.hpp>
#include <mongocxx/read_concern.hpp>
#include <mongocxx/write_concern.hpp>
#include <mongocxx/config/prelude.hpp>
namespace mongocxx {
namespace v_noabi {
namespace options {
class find_one_and_replace {
public:
find_one_and_replace() = default;
/* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE() find_one_and_replace(
v1::find_one_and_replace_options opts);
explicit operator v1::find_one_and_replace_options() const {
using bsoncxx::v_noabi::to_v1;
using mongocxx::v_noabi::to_v1;
v1::find_one_and_replace_options ret;
if (_bypass_document_validation) {
ret.bypass_document_validation(*_bypass_document_validation);
}
if (_collation) {
ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
}
if (_hint) {
ret.hint(to_v1(*_hint));
}
if (_let) {
ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
}
if (_comment) {
ret.comment(bsoncxx::v1::types::value{to_v1(*_comment)});
}
if (_max_time) {
ret.max_time(*_max_time);
}
if (_projection) {
ret.projection(bsoncxx::v1::document::value{to_v1(_projection->view())});
}
if (_return_document) {
ret.return_document(*_return_document);
}
if (_ordering) {
ret.sort(bsoncxx::v1::document::value{to_v1(_ordering->view())});
}
if (_upsert) {
ret.upsert(*_upsert);
}
if (_read_concern) {
ret.read_concern(to_v1(*_read_concern));
}
if (_write_concern) {
ret.write_concern(to_v1(*_write_concern));
}
return ret;
}
find_one_and_replace& 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;
}
find_one_and_replace& bypass_document_validation(bool bypass_document_validation) {
_bypass_document_validation = bypass_document_validation;
return *this;
}
bsoncxx::v_noabi::stdx::optional<bool> const& bypass_document_validation() const {
return _bypass_document_validation;
}
find_one_and_replace& 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;
}
find_one_and_replace& let(bsoncxx::v_noabi::document::view_or_value let) {
_let = std::move(let);
return *this;
}
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const let() const {
return _let;
}
find_one_and_replace& 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;
}
find_one_and_replace& 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;
}
find_one_and_replace& projection(bsoncxx::v_noabi::document::view_or_value projection) {
_projection = std::move(projection);
return *this;
}
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const& projection() const {
return _projection;
}
find_one_and_replace& return_document(return_document return_document) {
_return_document = return_document;
return *this;
}
bsoncxx::v_noabi::stdx::optional<v_noabi::options::return_document> const& return_document() const {
return _return_document;
}
find_one_and_replace& sort(bsoncxx::v_noabi::document::view_or_value ordering) {
_ordering = std::move(ordering);
return *this;
}
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const& sort() const {
return _ordering;
}
find_one_and_replace& upsert(bool upsert) {
_upsert = upsert;
return *this;
}
bsoncxx::v_noabi::stdx::optional<bool> const& upsert() const {
return _upsert;
}
find_one_and_replace& read_concern(v_noabi::read_concern read_concern) {
_read_concern = std::move(read_concern);
return *this;
}
bsoncxx::v_noabi::stdx::optional<v_noabi::read_concern> const& read_concern() const {
return _read_concern;
}
find_one_and_replace& write_concern(v_noabi::write_concern write_concern) {
_write_concern = std::move(write_concern);
return *this;
}
bsoncxx::v_noabi::stdx::optional<v_noabi::write_concern> const& write_concern() const {
return _write_concern;
}
private:
bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
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::document::view_or_value> _let;
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> _max_time;
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _projection;
bsoncxx::v_noabi::stdx::optional<v_noabi::options::return_document> _return_document;
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _ordering;
bsoncxx::v_noabi::stdx::optional<bool> _upsert;
bsoncxx::v_noabi::stdx::optional<v_noabi::read_concern> _read_concern;
bsoncxx::v_noabi::stdx::optional<v_noabi::write_concern> _write_concern;
};
} // namespace options
} // namespace v_noabi
} // namespace mongocxx
namespace mongocxx {
namespace v_noabi {
inline v_noabi::options::find_one_and_replace from_v1(v1::find_one_and_replace_options v) {
return {std::move(v)};
}
inline v1::find_one_and_replace_options to_v1(v_noabi::options::find_one_and_replace const& v) {
return v1::find_one_and_replace_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::find_one_and_replace::find_one_and_replace
find_one_and_replace()=default
Default initialization.
mongocxx::v1::find_one_and_replace_options
Options for a "findOneAndReplace" operation.
Definition find_one_and_replace_options.hpp:63
mongocxx::v1::find_one_and_replace_options::let
find_one_and_replace_options & let(bsoncxx::v1::document::value v)
Set the "let" field.
mongocxx::v1::find_one_and_replace_options::hint
find_one_and_replace_options & hint(v1::hint v)
Set the "hint" field.
mongocxx::v1::find_one_and_replace_options::collation
find_one_and_replace_options & collation(bsoncxx::v1::document::value v)
Set the "collation" field.
mongocxx::v1::find_one_and_replace_options::comment
find_one_and_replace_options & comment(bsoncxx::v1::types::value v)
Set the "comment" field.
mongocxx::v1::find_one_and_replace_options::return_document
find_one_and_replace_options & return_document(v1::return_document v)
Set the "returnDocument" field.
mongocxx::v1::find_one_and_replace_options::upsert
find_one_and_replace_options & upsert(bool v)
Set the "upsert" field.
mongocxx::v1::find_one_and_replace_options::bypass_document_validation
find_one_and_replace_options & bypass_document_validation(bool v)
Set the "bypassDocumentValidation" field.
mongocxx::v1::find_one_and_replace_options::max_time
find_one_and_replace_options & max_time(std::chrono::milliseconds v)
Set the "maxTimeMS" field.
mongocxx::v1::find_one_and_replace_options::projection
find_one_and_replace_options & projection(bsoncxx::v1::document::value v)
Set the "projection" field.
mongocxx::v1::find_one_and_replace_options::write_concern
find_one_and_replace_options & write_concern(v1::write_concern v)
Set the "writeConcern" field.
mongocxx::v1::find_one_and_replace_options::read_concern
find_one_and_replace_options & read_concern(v1::read_concern v)
Set the "readConcern" field.
mongocxx::v1::find_one_and_replace_options::sort
find_one_and_replace_options & sort(bsoncxx::v1::document::value v)
Set the "sort" 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::find_one_and_replace
Used by mongocxx::v_noabi::collection.
Definition find_one_and_replace.hpp:50
mongocxx::v_noabi::options::find_one_and_replace::read_concern
bsoncxx::v_noabi::stdx::optional< v_noabi::read_concern > const & read_concern() const
Gets the current read concern.
Definition find_one_and_replace.hpp:449
mongocxx::v_noabi::options::find_one_and_replace::upsert
find_one_and_replace & upsert(bool upsert)
Sets the upsert flag on the operation. When true, the operation creates a new document if no document...
Definition find_one_and_replace.hpp:405
mongocxx::v_noabi::options::find_one_and_replace::return_document
bsoncxx::v_noabi::stdx::optional< v_noabi::options::return_document > const & return_document() const
Which version of the replaced document to return.
Definition find_one_and_replace.hpp:353
mongocxx::v_noabi::options::find_one_and_replace::bypass_document_validation
bsoncxx::v_noabi::stdx::optional< bool > const & bypass_document_validation() const
The current setting for bypassing document validation.
Definition find_one_and_replace.hpp:183
mongocxx::v_noabi::options::find_one_and_replace::sort
find_one_and_replace & sort(bsoncxx::v_noabi::document::view_or_value ordering)
Sets the order by which to search the collection for a matching document.
Definition find_one_and_replace.hpp:373
mongocxx::v_noabi::options::find_one_and_replace::return_document
find_one_and_replace & return_document(return_document return_document)
Set the desired version of the replaced document to return, either the original document,...
Definition find_one_and_replace.hpp:339
mongocxx::v_noabi::options::find_one_and_replace::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 find_one_and_replace.hpp:260
mongocxx::v_noabi::options::find_one_and_replace::let
find_one_and_replace & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Definition find_one_and_replace.hpp:224
mongocxx::v_noabi::options::find_one_and_replace::write_concern
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
Gets the current write concern.
Definition find_one_and_replace.hpp:480
mongocxx::v_noabi::options::find_one_and_replace::comment
find_one_and_replace & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition find_one_and_replace.hpp:249
mongocxx::v_noabi::options::find_one_and_replace::read_concern
find_one_and_replace & read_concern(v_noabi::read_concern read_concern)
Sets the read concern for this operation.
Definition find_one_and_replace.hpp:435
mongocxx::v_noabi::options::find_one_and_replace::bypass_document_validation
find_one_and_replace & bypass_document_validation(bool bypass_document_validation)
Whether or not to bypass document validation for this operation.
Definition find_one_and_replace.hpp:170
mongocxx::v_noabi::options::find_one_and_replace::upsert
bsoncxx::v_noabi::stdx::optional< bool > const & upsert() const
Gets the current upsert setting.
Definition find_one_and_replace.hpp:418
mongocxx::v_noabi::options::find_one_and_replace::projection
find_one_and_replace & projection(bsoncxx::v_noabi::document::view_or_value projection)
Sets a projection, which limits the fields to return.
Definition find_one_and_replace.hpp:307
mongocxx::v_noabi::options::find_one_and_replace::max_time
find_one_and_replace & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
Definition find_one_and_replace.hpp:277
mongocxx::v_noabi::options::find_one_and_replace::sort
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & sort() const
Gets the current sort ordering.
Definition find_one_and_replace.hpp:386
mongocxx::v_noabi::options::find_one_and_replace::hint
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition find_one_and_replace.hpp:210
mongocxx::v_noabi::options::find_one_and_replace::projection
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & projection() const
Gets the current projection for this operation.
Definition find_one_and_replace.hpp:320
mongocxx::v_noabi::options::find_one_and_replace::find_one_and_replace_options
operator v1::find_one_and_replace_options() const
Convert to the mongocxx::v1 equivalent.
Definition find_one_and_replace.hpp:66
mongocxx::v_noabi::options::find_one_and_replace::find_one_and_replace
find_one_and_replace()=default
Default initialization.
mongocxx::v_noabi::options::find_one_and_replace::collation
find_one_and_replace & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition find_one_and_replace.hpp:135
mongocxx::v_noabi::options::find_one_and_replace::write_concern
find_one_and_replace & write_concern(v_noabi::write_concern write_concern)
Sets the write concern for this operation.
Definition find_one_and_replace.hpp:466
mongocxx::v_noabi::options::find_one_and_replace::collation
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
Definition find_one_and_replace.hpp:149
mongocxx::v_noabi::options::find_one_and_replace::let
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const let() const
Gets the current value of the let option.
Definition find_one_and_replace.hpp:235
mongocxx::v_noabi::options::find_one_and_replace::max_time
bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > const & max_time() const
The current max_time setting.
Definition find_one_and_replace.hpp:290
mongocxx::v_noabi::options::find_one_and_replace::hint
find_one_and_replace & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition find_one_and_replace.hpp:200
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::write_concern
The level of acknowledgment requested for write operations to a MongoDB server.
Definition write_concern.hpp:54
view_or_value.hpp
Provides bsoncxx::v_noabi::document::view_or_value.
find_one_and_replace-fwd.hpp
Declares mongocxx::v_noabi::options::find_one_and_replace.
find_one_and_replace_options.hpp
Provides mongocxx::v1::find_one_and_replace_options.
find_one_common_options.hpp
Provides mongocxx::v_noabi::options::return_document.
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.
write_concern.hpp
Provides mongocxx::v_noabi::write_concern.