Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
attempt_context.hxx
Go to the documentation of this file.
1/*
2 * Copyright 2021-Present Couchbase, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16#pragma once
17
21
22#include <stdexcept>
23
24namespace couchbase
25{
26class collection;
27class scope;
28
29namespace transactions
30{
40{
41public:
65 virtual auto get(const couchbase::collection& coll,
66 const std::string& id) -> std::pair<error, transaction_get_result> = 0;
67
91 const std::string& id)
92 -> std::pair<error, transaction_get_result> = 0;
93
109 template<typename Transcoder = codec::default_json_transcoder,
110 typename Document,
111 std::enable_if_t<!std::is_same_v<codec::encoded_value, Document>, bool> = true>
113 const std::string& id,
114 const Document& content) -> std::pair<error, transaction_get_result>
115 {
117 try {
118 data = Transcoder::encode(content);
119 } catch (std::system_error& e) {
120 return { error(e.code(), e.what()), {} };
121 } catch (std::runtime_error& e) {
122 return { error(errc::common::encoding_failure, e.what()), {} };
123 }
124 return insert_raw(coll, id, data);
125 }
126
151 template<typename Transcoder = codec::default_json_transcoder,
152 typename Document,
153 std::enable_if_t<!std::is_same_v<codec::encoded_value, Document>, bool> = true>
155 const Document& content) -> std::pair<error, transaction_get_result>
156 {
158 try {
159 data = Transcoder::encode(content);
160 } catch (std::system_error& e) {
161 return { error(e.code(), e.what()), {} };
162 } catch (std::runtime_error& e) {
163 return { error(errc::common::encoding_failure, e.what()), {} };
164 }
165 return replace_raw(doc, data);
166 }
167
178 virtual auto remove(const transaction_get_result& doc) -> error = 0;
179
188 auto query(const std::string& statement, const transaction_query_options& options = {})
189 -> std::pair<error, transaction_query_result>;
190
200 auto query(const scope& scope,
201 const std::string& statement,
202 const transaction_query_options& opts = {})
203 -> std::pair<error, transaction_query_result>;
204
205 virtual ~attempt_context() = default;
206
207protected:
209 virtual auto replace_raw(const transaction_get_result& doc, codec::encoded_value content)
210 -> std::pair<error, transaction_get_result> = 0;
212 virtual auto insert_raw(const couchbase::collection& coll,
213 const std::string& id,
214 codec::encoded_value document)
215 -> std::pair<error, transaction_get_result> = 0;
217 virtual auto do_public_query(const std::string& statement,
218 const transaction_query_options& options,
219 std::optional<std::string> query_context)
220 -> std::pair<error, transaction_query_result> = 0;
221};
222} // namespace transactions
223} // namespace couchbase
The collection provides access to all collection APIs.
Definition collection.hxx:70
Definition error.hxx:30
The scope identifies a group of collections and allows high application density as a result.
Definition scope.hxx:47
The attempt_context is used for all synchronous transaction operations.
Definition attempt_context.hxx:40
auto query(const scope &scope, const std::string &statement, const transaction_query_options &opts={}) -> std::pair< error, transaction_query_result >
Perform a scoped query.
virtual auto get_replica_from_preferred_server_group(const couchbase::collection &coll, const std::string &id) -> std::pair< error, transaction_get_result >=0
Get a document copy from the selected server group.
auto insert(const couchbase::collection &coll, const std::string &id, const Document &content) -> std::pair< error, transaction_get_result >
Insert a document into a collection.
Definition attempt_context.hxx:112
auto query(const std::string &statement, const transaction_query_options &options={}) -> std::pair< error, transaction_query_result >
Perform an unscoped query.
virtual auto remove(const transaction_get_result &doc) -> error=0
Remove a document.
virtual auto get(const couchbase::collection &coll, const std::string &id) -> std::pair< error, transaction_get_result >=0
Get a document from a collection.
auto replace(const transaction_get_result &doc, const Document &content) -> std::pair< error, transaction_get_result >
Replace the contents of a document in a collection.
Definition attempt_context.hxx:154
The representation of the document in context of distributed transaction.
Definition transaction_get_result.hxx:57
The transaction_query_options are options specific to a query.
Definition transaction_query_options.hxx:35
json_transcoder< tao_json_serializer > default_json_transcoder
Definition default_json_transcoder.hxx:28
@ encoding_failure
Returned when encoding of a user object failed while trying to write it to the cluster.
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
@ error
Indicates that the ping operation failed.
Definition encoded_value.hxx:27