Couchbase C++ SDK 1.0.4 (rev. 5355b0f)
Loading...
Searching...
No Matches
insert.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/*
3 * Copyright 2020-Present Couchbase, Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#pragma once
19
22
24
25#include <string>
26#include <vector>
27
28namespace couchbase
29{
30class mutate_in_specs;
31
32namespace subdoc
33{
40class insert
41{
42public:
52 auto xattr(bool value = true) -> insert&
53 {
54 xattr_ = value;
55 return *this;
56 }
57
67 auto create_path(bool value = true) -> insert&
68 {
69 create_path_ = value;
70 return *this;
71 }
72
82 auto binary(bool value = true) -> insert&
83 {
84 binary_ = value;
85 return *this;
86 }
87
88private:
89#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
91#endif
92
93 insert(std::string path, std::vector<std::byte> value)
94 : path_(std::move(path))
95 , value_(std::move(value))
96 {
97 }
98
99 insert(std::string path, std::vector<std::byte> value, bool expand_macro)
100 : path_(std::move(path))
101 , value_(std::move(value))
102 , expand_macro_(expand_macro)
103 {
104 }
105
106 insert(std::string path, mutate_in_macro value)
107 : path_(std::move(path))
108 , value_(to_binary(value))
109 , expand_macro_(true)
110 {
111 }
112
113 void encode(core::impl::subdoc::command_bundle& bundle) const;
114
115 std::string path_;
116 std::vector<std::byte> value_;
117 bool xattr_{ false };
118 bool expand_macro_{ false };
119 bool create_path_{ false };
120 bool binary_{ false };
121};
122} // namespace subdoc
123} // namespace couchbase
Definition mutate_in_specs.hxx:80
An intention to perform a SubDocument insert operation.
Definition insert.hxx:41
auto binary(bool value=true) -> insert &
Sets whether the value should be treated as a binary.
Definition insert.hxx:82
auto create_path(bool value=true) -> insert &
Sets that this parent fields should be created automatically.
Definition insert.hxx:67
auto xattr(bool value=true) -> insert &
Sets that this is an extended attribute (xattr) field.
Definition insert.hxx:52
mutate_in_macro
Definition mutate_in_macro.hxx:29
auto to_binary(mutate_in_macro value) -> std::vector< std::byte >
Converts macro into binary array suitable for sending to the server.
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
@ insert
Create the document, fail if it exists.