Loading...
Searching...
No Matches
delete.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/delete-fwd.hpp> // IWYU pragma: export
//
#include <bsoncxx/v1/document/value.hpp>
#include <bsoncxx/v1/types/value.hpp>
#include <mongocxx/v1/delete_many_options.hpp> // IWYU pragma: export
#include <mongocxx/v1/delete_one_options.hpp> // IWYU pragma: export
#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/write_concern.hpp>
#include <mongocxx/config/prelude.hpp>
namespace mongocxx {
namespace v_noabi {
namespace options {
class delete_options {
public:
delete_options() = default;
/* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE() delete_options(v1::delete_many_options opts);
/* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE() delete_options(v1::delete_one_options opts);
explicit operator v1::delete_many_options() const {
using bsoncxx::v_noabi::to_v1;
using mongocxx::v_noabi::to_v1;
v1::delete_many_options ret;
if (_collation) {
ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
}
if (_read_concern) {
ret.read_concern(to_v1(*_read_concern));
}
if (_write_concern) {
ret.write_concern(to_v1(*_write_concern));
}
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::delete_one_options() const {
using bsoncxx::v_noabi::to_v1;
using mongocxx::v_noabi::to_v1;
v1::delete_one_options ret;
if (_collation) {
ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
}
if (_read_concern) {
ret.read_concern(to_v1(*_read_concern));
}
if (_write_concern) {
ret.write_concern(to_v1(*_write_concern));
}
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;
}
delete_options& 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;
}
delete_options& 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;
}
delete_options& 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;
}
delete_options& 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;
}
delete_options& 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;
}
delete_options& 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;
}
private:
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
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<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;
};
} // namespace options
} // namespace v_noabi
} // namespace mongocxx
namespace mongocxx {
namespace v_noabi {
inline v_noabi::options::delete_options from_v1(v1::delete_many_options v) {
return {std::move(v)};
}
inline v_noabi::options::delete_options from_v1(v1::delete_one_options v) {
return {std::move(v)};
}
// Ambiguous whether `v_noabi::options::delete_options` should be converted to `v1::delete_many_options` or
// `v1::delete_one_options`. Require users to explicitly cast to the expected type instead.
//
// v1::delete_many_options to_v1(v_noabi::options::delete_options const& v);
// v1::delete_one_options to_v1(v_noabi::options::delete_options const& 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::delete_options::delete_options
delete_options()=default
Default initialization.
mongocxx::v1::delete_many_options
Options for a "deleteMany" operation.
Definition delete_many_options.hpp:53
mongocxx::v1::delete_many_options::read_concern
delete_many_options & read_concern(v1::read_concern v)
Set the "readConcern" field.
mongocxx::v1::delete_many_options::hint
delete_many_options & hint(v1::hint v)
Set the "hint" field.
mongocxx::v1::delete_many_options::comment
delete_many_options & comment(bsoncxx::v1::types::value v)
Set the "comment" field.
mongocxx::v1::delete_many_options::write_concern
delete_many_options & write_concern(v1::write_concern v)
Set the "writeConcern" field.
mongocxx::v1::delete_many_options::collation
delete_many_options & collation(bsoncxx::v1::document::value v)
Set the "collation" field.
mongocxx::v1::delete_many_options::let
delete_many_options & let(bsoncxx::v1::document::value v)
Set the "let" field.
mongocxx::v1::delete_one_options
Options for a "deleteOne" operation.
Definition delete_one_options.hpp:53
mongocxx::v1::delete_one_options::comment
delete_one_options & comment(bsoncxx::v1::types::value v)
Set the "comment" field.
mongocxx::v1::delete_one_options::let
delete_one_options & let(bsoncxx::v1::document::value v)
Set the "let" field.
mongocxx::v1::delete_one_options::hint
delete_one_options & hint(v1::hint v)
Set the "hint" field.
mongocxx::v1::delete_one_options::write_concern
delete_one_options & write_concern(v1::write_concern v)
Set the "writeConcern" field.
mongocxx::v1::delete_one_options::read_concern
delete_one_options & read_concern(v1::read_concern v)
Set the "readConcern" field.
mongocxx::v1::delete_one_options::collation
delete_one_options & collation(bsoncxx::v1::document::value v)
Set the "collation" 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::delete_options
Used by MongoDB delete operations.
Definition delete.hpp:48
mongocxx::v_noabi::options::delete_options::collation
delete_options & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition delete.hpp:150
mongocxx::v_noabi::options::delete_options::delete_options
delete_options()=default
Default initialization.
mongocxx::v_noabi::options::delete_options::let
delete_options & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Definition delete.hpp:267
mongocxx::v_noabi::options::delete_options::hint
delete_options & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition delete.hpp:243
mongocxx::v_noabi::options::delete_options::hint
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition delete.hpp:253
mongocxx::v_noabi::options::delete_options::write_concern
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
The current write_concern for this operation.
Definition delete.hpp:226
mongocxx::v_noabi::options::delete_options::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 delete.hpp:303
mongocxx::v_noabi::options::delete_options::comment
delete_options & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
Definition delete.hpp:292
mongocxx::v_noabi::options::delete_options::collation
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
Definition delete.hpp:164
mongocxx::v_noabi::options::delete_options::delete_one_options
operator v1::delete_one_options() const
Convert to the mongocxx::v1 equivalent.
Definition delete.hpp:104
mongocxx::v_noabi::options::delete_options::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 delete.hpp:278
mongocxx::v_noabi::options::delete_options::delete_many_options
operator v1::delete_many_options() const
Convert to the mongocxx::v1 equivalent.
Definition delete.hpp:68
mongocxx::v_noabi::options::delete_options::write_concern
delete_options & write_concern(v_noabi::write_concern wc)
Sets the write_concern for this operation.
Definition delete.hpp:212
mongocxx::v_noabi::options::delete_options::read_concern
bsoncxx::v_noabi::stdx::optional< v_noabi::read_concern > const & read_concern() const
The current read_concern for this operation.
Definition delete.hpp:195
mongocxx::v_noabi::options::delete_options::read_concern
delete_options & read_concern(v_noabi::read_concern rc)
Sets the read_concern for this operation.
Definition delete.hpp:181
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
delete_many_options.hpp
Provides mongocxx::v1::delete_many_options.
delete_one_options.hpp
Provides mongocxx::v1::delete_one_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.
delete-fwd.hpp
Declares mongocxx::v_noabi::options::delete_options.
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.