Loading...
Searching...
No Matches
update.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/update-fwd.hpp> // IWYU pragma: export
//
#include <bsoncxx/v1/array/value.hpp>
#include <bsoncxx/v1/document/value.hpp>
#include <bsoncxx/v1/types/value.hpp>
#include <mongocxx/v1/update_many_options.hpp> // IWYU pragma: export
#include <mongocxx/v1/update_one_options.hpp> // IWYU pragma: export
#include <utility>
#include <bsoncxx/array/view.hpp>
#include <bsoncxx/array/view_or_value.hpp>
#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/write_concern.hpp>
#include <mongocxx/config/prelude.hpp>
namespace mongocxx {
namespace v_noabi {
namespace options {
class update {
public:
update() = default;
/* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE() update(v1::update_many_options opts);
/* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE() update(v1::update_one_options opts);
explicit operator v1::update_many_options() const {
using bsoncxx::v_noabi::to_v1;
using mongocxx::v_noabi::to_v1;
v1::update_many_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 (_upsert) {
ret.upsert(*_upsert);
}
if (_read_concern) {
ret.read_concern(to_v1(*_read_concern));
}
if (_write_concern) {
ret.write_concern(to_v1(*_write_concern));
}
if (_array_filters) {
ret.array_filters(bsoncxx::v1::array::value{to_v1(*_array_filters)});
}
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->view())});
}
return ret;
}
explicit operator v1::update_one_options() const {
using bsoncxx::v_noabi::to_v1;
using mongocxx::v_noabi::to_v1;
v1::update_one_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 (_upsert) {
ret.upsert(*_upsert);
}
if (_read_concern) {
ret.read_concern(to_v1(*_read_concern));
}
if (_write_concern) {
ret.write_concern(to_v1(*_write_concern));
}
if (_array_filters) {
ret.array_filters(bsoncxx::v1::array::value{to_v1(*_array_filters)});
}
if (_hint) {
ret.hint(to_v1(*_hint));
}
if (_let) {
ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
}
if (_sort) {
ret.sort(bsoncxx::v1::document::value{to_v1(_sort->view())});
}
if (_comment) {
ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
}
return ret;
}
update& 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;
}
update& 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;
}
update& 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;
}
update& 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;
}
update& sort(bsoncxx::v_noabi::document::view_or_value sort) {
_sort = std::move(sort);
return *this;
}
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const& sort() const {
return _sort;
}
update& 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;
}
update& upsert(bool upsert) {
_upsert = upsert;
return *this;
}
bsoncxx::v_noabi::stdx::optional<bool> const& upsert() const {
return _upsert;
}
update& 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;
}
update& write_concern(v_noabi::write_concern wc) {
_write_concern = std::move(wc);
return *this;
}
bsoncxx::v_noabi::stdx::optional<v_noabi::write_concern> const& write_concern() const {
return _write_concern;
}
update& array_filters(bsoncxx::v_noabi::array::view_or_value array_filters) {
_array_filters = std::move(array_filters);
return *this;
}
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::array::view_or_value> const& array_filters() const {
return _array_filters;
}
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<bool> _upsert;
bsoncxx::v_noabi::stdx::optional<v_noabi::read_concern> _read_concern;
bsoncxx::v_noabi::stdx::optional<v_noabi::write_concern> _write_concern;
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::array::view_or_value> _array_filters;
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::document::view_or_value> _sort;
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
};
} // namespace options
} // namespace v_noabi
} // namespace mongocxx
namespace mongocxx {
namespace v_noabi {
inline v_noabi::options::update from_v1(v1::update_many_options v) {
return {std::move(v)};
}
inline v_noabi::options::update from_v1(v1::update_one_options v) {
return {std::move(v)};
}
// Ambiguous whether `v_noabi::options::update` should be converted to `v1::update_many_options` or
// `v1::update_one_options`. Require users to explicitly cast to the expected type instead.
//
// v1::update_many_options to_v1(v_noabi::options::update const& v);
// v1::update_one_options to_v1(v_noabi::options::update const& v);
} // namespace v_noabi
} // namespace mongocxx
#include <mongocxx/config/postlude.hpp>
view_or_value.hpp
Provides bsoncxx::v_noabi::array::view_or_value.
bsoncxx::v1::array::value
A BSON array.
Definition value.hpp:39
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::update::update
update()=default
Default initialization.
mongocxx::v1::update_many_options
Options for an "updateMany" operation.
Definition update_many_options.hpp:58
mongocxx::v1::update_many_options::hint
update_many_options & hint(v1::hint v)
Set the "hint" field.
mongocxx::v1::update_many_options::bypass_document_validation
update_many_options & bypass_document_validation(bool v)
Set the "bypassDocumentValidation" field.
mongocxx::v1::update_many_options::upsert
update_many_options & upsert(bool v)
Set the "upsert" field.
mongocxx::v1::update_many_options::read_concern
update_many_options & read_concern(v1::read_concern v)
Set the "readConcern" field.
mongocxx::v1::update_many_options::collation
update_many_options & collation(bsoncxx::v1::document::value v)
Set the "collation" field.
mongocxx::v1::update_many_options::comment
update_many_options & comment(bsoncxx::v1::types::value v)
Set the "comment" field.
mongocxx::v1::update_many_options::write_concern
update_many_options & write_concern(v1::write_concern v)
Set the "writeConcern" field.
mongocxx::v1::update_many_options::let
update_many_options & let(bsoncxx::v1::document::value v)
Set the "let" field.
mongocxx::v1::update_many_options::array_filters
update_many_options & array_filters(bsoncxx::v1::array::value v)
Set the "arrayFilters" field.
mongocxx::v1::update_one_options
Options for an "updateOne" operation.
Definition update_one_options.hpp:59
mongocxx::v1::update_one_options::comment
update_one_options & comment(bsoncxx::v1::types::value v)
Set the "comment" field.
mongocxx::v1::update_one_options::upsert
update_one_options & upsert(bool v)
Set the "upsert" field.
mongocxx::v1::update_one_options::collation
update_one_options & collation(bsoncxx::v1::document::value v)
Set the "collation" field.
mongocxx::v1::update_one_options::read_concern
update_one_options & read_concern(v1::read_concern v)
Set the "readConcern" field.
mongocxx::v1::update_one_options::sort
update_one_options & sort(bsoncxx::v1::document::value v)
Set the "sort" field.
mongocxx::v1::update_one_options::hint
update_one_options & hint(v1::hint v)
Set the "hint" field.
mongocxx::v1::update_one_options::bypass_document_validation
update_one_options & bypass_document_validation(bool v)
Set the "bypassDocumentValidation" field.
mongocxx::v1::update_one_options::let
update_one_options & let(bsoncxx::v1::document::value v)
Set the "let" field.
mongocxx::v1::update_one_options::write_concern
update_one_options & write_concern(v1::write_concern v)
Set the "writeConcern" field.
mongocxx::v1::update_one_options::array_filters
update_one_options & array_filters(bsoncxx::v1::array::value v)
Set the "arrayFilters" 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::update
Used by mongocxx::v_noabi::collection.
Definition update.hpp:51
mongocxx::v_noabi::options::update::comment
update & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition update.hpp:307
mongocxx::v_noabi::options::update::array_filters
update & array_filters(bsoncxx::v_noabi::array::view_or_value array_filters)
Set array filters for this operation.
Definition update.hpp:427
mongocxx::v_noabi::options::update::write_concern
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
The current write_concern for this operation.
Definition update.hpp:410
mongocxx::v_noabi::options::update::hint
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition update.hpp:253
mongocxx::v_noabi::options::update::collation
update & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition update.hpp:212
mongocxx::v_noabi::options::update::upsert
update & upsert(bool upsert)
Sets the upsert option.
Definition update.hpp:338
mongocxx::v_noabi::options::update::upsert
bsoncxx::v_noabi::stdx::optional< bool > const & upsert() const
Gets the current value of the upsert option.
Definition update.hpp:348
mongocxx::v_noabi::options::update::bypass_document_validation
update & bypass_document_validation(bool bypass_document_validation)
Sets the bypass_document_validation option. If true, allows the write to opt-out of document level va...
Definition update.hpp:185
mongocxx::v_noabi::options::update::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 update.hpp:278
mongocxx::v_noabi::options::update::update_many_options
operator v1::update_many_options() const
Convert to the mongocxx::v1 equivalent.
Definition update.hpp:73
mongocxx::v_noabi::options::update::bypass_document_validation
bsoncxx::v_noabi::stdx::optional< bool > const & bypass_document_validation() const
Gets the current value of the bypass_document_validation option.
Definition update.hpp:195
mongocxx::v_noabi::options::update::collation
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
Definition update.hpp:226
mongocxx::v_noabi::options::update::read_concern
bsoncxx::v_noabi::stdx::optional< v_noabi::read_concern > const & read_concern() const
The current read_concern for this operation.
Definition update.hpp:379
mongocxx::v_noabi::options::update::update
update()=default
Default initialization.
mongocxx::v_noabi::options::update::sort
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & sort() const
Get the current value of the sort option.
Definition update.hpp:293
mongocxx::v_noabi::options::update::read_concern
update & read_concern(v_noabi::read_concern rc)
Sets the read_concern for this operation.
Definition update.hpp:365
mongocxx::v_noabi::options::update::array_filters
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::array::view_or_value > const & array_filters() const
Get array filters for this operation.
Definition update.hpp:441
mongocxx::v_noabi::options::update::let
update & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Definition update.hpp:267
mongocxx::v_noabi::options::update::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 update.hpp:318
mongocxx::v_noabi::options::update::hint
update & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition update.hpp:243
mongocxx::v_noabi::options::update::update_one_options
operator v1::update_one_options() const
Convert to the mongocxx::v1 equivalent.
Definition update.hpp:121
mongocxx::v_noabi::options::update::sort
update & sort(bsoncxx::v_noabi::document::view_or_value sort)
Set the sort option.
Definition update.hpp:285
mongocxx::v_noabi::options::update::write_concern
update & write_concern(v_noabi::write_concern wc)
Sets the write_concern for this operation.
Definition update.hpp:396
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.
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::array::view_or_value
v_noabi::view_or_value< view, value > view_or_value
Equivalent to v_noabi::view_or_value<v_noabi::array::view, v_noabi::array::value>.
Definition view_or_value.hpp:31
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.
update-fwd.hpp
Declares mongocxx::v_noabi::options::update.
view_or_value.hpp
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
update_many_options.hpp
Provides mongocxx::v1::update_many_options.
update_one_options.hpp
Provides mongocxx::v1::update_one_options.
value.hpp
Provides bsoncxx::v1::array::value.
value.hpp
Provides bsoncxx::v1::document::value.
value.hpp
Provides bsoncxx::v1::types::value.
view.hpp
Provides bsoncxx::v_noabi::array::view.
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.