libpqxx  7.6.1
result.hxx
1 /* Definitions for the pqxx::result class and support classes.
2  *
3  * pqxx::result represents the set of result rows from a database query.
4  *
5  * DO NOT INCLUDE THIS FILE DIRECTLY; include pqxx/result instead.
6  *
7  * Copyright (c) 2000-2022, Jeroen T. Vermeulen.
8  *
9  * See COPYING for copyright license. If you did not receive a file called
10  * COPYING with this source code, please notify the distributor of this
11  * mistake, or contact the author.
12  */
13 #ifndef PQXX_H_RESULT
14 #define PQXX_H_RESULT
15 
16 #include "pqxx/compiler-public.hxx"
17 #include "pqxx/internal/compiler-internal-pre.hxx"
18 
19 #include <ios>
20 #include <memory>
21 #include <stdexcept>
22 
23 #include "pqxx/except.hxx"
24 #include "pqxx/types.hxx"
25 #include "pqxx/util.hxx"
26 #include "pqxx/zview.hxx"
27 
28 #include "pqxx/internal/encodings.hxx"
29 
30 
31 namespace pqxx::internal
32 {
33 PQXX_LIBEXPORT void clear_result(pq::PGresult const *);
34 }
35 
36 
37 namespace pqxx::internal::gate
38 {
39 class result_connection;
40 class result_creation;
41 class result_pipeline;
42 class result_row;
43 class result_sql_cursor;
44 } // namespace pqxx::internal::gate
45 
46 
47 namespace pqxx
48 {
50 
70 class PQXX_LIBEXPORT result
71 {
72 public:
75  using reference = row;
81 
82  result() noexcept :
83  m_data(make_data_pointer()),
84  m_query(),
85  m_encoding(internal::encoding_group::MONOBYTE)
86  {}
87 
88  result(result const &rhs) noexcept = default;
89 
91 
94  result &operator=(result const &rhs) noexcept = default;
95 
104  [[nodiscard]] bool operator==(result const &) const noexcept;
107  [[nodiscard]] bool operator!=(result const &rhs) const noexcept
108  {
109  return not operator==(rhs);
110  }
112 
114 
120  template<typename... TYPE> auto iter() const;
121 
122  [[nodiscard]] const_reverse_iterator rbegin() const;
123  [[nodiscard]] const_reverse_iterator crbegin() const;
124  [[nodiscard]] const_reverse_iterator rend() const;
125  [[nodiscard]] const_reverse_iterator crend() const;
126 
127  [[nodiscard]] const_iterator begin() const noexcept;
128  [[nodiscard]] const_iterator cbegin() const noexcept;
129  [[nodiscard]] inline const_iterator end() const noexcept;
130  [[nodiscard]] inline const_iterator cend() const noexcept;
131 
132  [[nodiscard]] reference front() const noexcept;
133  [[nodiscard]] reference back() const noexcept;
134 
135  [[nodiscard]] PQXX_PURE size_type size() const noexcept;
136  [[nodiscard]] PQXX_PURE bool empty() const noexcept;
137  [[nodiscard]] size_type capacity() const noexcept { return size(); }
138 
140 
144  void swap(result &) noexcept;
145 
147  [[nodiscard]] row operator[](size_type i) const noexcept;
149  row at(size_type) const;
150 
152 
159  void clear() noexcept
160  {
161  m_data.reset();
162  m_query = nullptr;
163  }
164 
169  [[nodiscard]] PQXX_PURE row_size_type columns() const noexcept;
171 
173  [[nodiscard]] row_size_type column_number(zview name) const;
174 
176  [[nodiscard]] char const *column_name(row_size_type number) const;
177 
179  [[nodiscard]] oid column_type(row_size_type col_num) const;
180 
182  [[nodiscard]] oid column_type(zview col_name) const
183  {
184  return column_type(column_number(col_name));
185  }
186 
188  [[nodiscard]] oid column_table(row_size_type col_num) const;
189 
191  [[nodiscard]] oid column_table(zview col_name) const
192  {
193  return column_table(column_number(col_name));
194  }
195 
197  [[nodiscard]] row_size_type table_column(row_size_type col_num) const;
198 
200  [[nodiscard]] row_size_type table_column(zview col_name) const
201  {
202  return table_column(column_number(col_name));
203  }
205 
207  [[nodiscard]] PQXX_PURE std::string const &query() const noexcept;
208 
210 
213  [[nodiscard]] PQXX_PURE oid inserted_oid() const;
214 
217 
220  [[nodiscard]] PQXX_PURE size_type affected_rows() const;
221 
222 
223 private:
224  using data_pointer = std::shared_ptr<internal::pq::PGresult const>;
225 
227  data_pointer m_data;
228 
230  static data_pointer
231  make_data_pointer(internal::pq::PGresult const *res = nullptr)
232  {
233  return data_pointer{res, internal::clear_result};
234  }
235 
236  friend class pqxx::internal::gate::result_pipeline;
237  PQXX_PURE std::shared_ptr<std::string> query_ptr() const noexcept
238  {
239  return m_query;
240  }
241 
243  std::shared_ptr<std::string> m_query;
244 
245  internal::encoding_group m_encoding;
246 
247  static std::string const s_empty_string;
248 
249  friend class pqxx::field;
250  PQXX_PURE char const *get_value(size_type row, row_size_type col) const;
251  PQXX_PURE bool get_is_null(size_type row, row_size_type col) const;
252  PQXX_PURE
253  field_size_type get_length(size_type, row_size_type) const noexcept;
254 
255  friend class pqxx::internal::gate::result_creation;
256  result(
257  internal::pq::PGresult *rhs, std::shared_ptr<std::string> query,
258  internal::encoding_group enc);
259 
260  PQXX_PRIVATE void check_status(std::string_view desc = ""sv) const;
261 
262  friend class pqxx::internal::gate::result_connection;
263  friend class pqxx::internal::gate::result_row;
264  bool operator!() const noexcept { return m_data.get() == nullptr; }
265  operator bool() const noexcept { return m_data.get() != nullptr; }
266 
267  [[noreturn]] PQXX_PRIVATE void
268  throw_sql_error(std::string const &Err, std::string const &Query) const;
269  PQXX_PRIVATE PQXX_PURE int errorposition() const;
270  PQXX_PRIVATE std::string status_error() const;
271 
272  friend class pqxx::internal::gate::result_sql_cursor;
273  PQXX_PURE char const *cmd_status() const noexcept;
274 };
275 } // namespace pqxx
276 
277 #include "pqxx/internal/compiler-internal-post.hxx"
278 #endif
void clear() noexcept
Let go of the result&#39;s data.
Definition: result.hxx:159
Reverse iterator for result. Use as result::const_reverse_iterator.
Definition: result_iterator.hxx:195
Marker-type wrapper: zero-terminated std::string_view.
Definition: zview.hxx:39
row_size_type col() const noexcept
Definition: field.hxx:258
std::size_t field_size_type
Number of bytes in a field of database data.
Definition: types.hxx:36
Iterator for rows in a result. Use as result::const_iterator.
Definition: result_iterator.hxx:35
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:25
int row_size_type
Number of fields in a row of database data.
Definition: types.hxx:30
int result_difference_type
Difference between result sizes.
Definition: types.hxx:27
int result_size_type
Number of rows in a result set.
Definition: types.hxx:24
result_difference_type difference_type
Definition: result.hxx:74
void clear_result(pq::PGresult const *)
C++ wrapper for libpq&#39;s PQclear.
Definition: result.cxx:37
bool operator!=(result const &rhs) const noexcept
Compare two results for inequality.
Definition: result.hxx:107
Reference to a field in a result set.
Definition: field.hxx:33
Definition: connection.hxx:94
result() noexcept
Definition: result.hxx:82
oid column_table(zview col_name) const
What table did this column come from?
Definition: result.hxx:191
oid column_type(zview col_name) const
Return column&#39;s type, as an OID from the system catalogue.
Definition: result.hxx:182
Reference to one row in a result.
Definition: row.hxx:45
Internal items for libpqxx&#39; own use. Do not use these yourself.
Definition: composite.hxx:73
size_type capacity() const noexcept
Definition: result.hxx:137
Result set containing data returned by a query or command.
Definition: result.hxx:70
row_size_type table_column(zview col_name) const
What column in its table did this column come from?
Definition: result.hxx:200
result_size_type size_type
Definition: result.hxx:73