16 #include "pqxx/compiler-public.hxx"
17 #include "pqxx/internal/compiler-internal-pre.hxx"
22 #include "pqxx/result.hxx"
23 #include "pqxx/transaction_base.hxx"
122 [[nodiscard]]
static difference_type backward_all() noexcept;
132 [[nodiscard]] std::
string const &name() const noexcept {
return m_name; }
142 #include <pqxx/internal/sql_cursor.hxx>
154 template<cursor_base::update_policy up, cursor_base::ownership_policy op>
165 m_cur{trans, query, cname,
cursor_base::random_access, up, op, hold}
170 m_cur{trans, adopted_cursor, op}
177 void close() noexcept { m_cur.close(); }
185 return internal::obtain_stateless_cursor_size(m_cur);
202 return internal::stateless_cursor_retrieve(
207 [[nodiscard]] std::string
const &
name() const noexcept
213 internal::sql_cursor m_cur;
217 class icursor_iterator;
223 class icursor_iterator_icursorstream;
224 class icursorstream_icursor_iterator;
298 operator bool() const noexcept {
return not m_done; }
332 void set_stride(difference_type stride);
338 friend class internal::gate::icursorstream_icursor_iterator;
345 internal::sql_cursor m_cur;
417 return not operator==(rhs);
426 return not(*
this > rhs);
430 return not(*
this < rhs);
434 void refresh()
const;
436 friend class internal::gate::icursor_iterator_icursorstream;
438 void fill(
result const &);
442 difference_type m_pos;
443 icursor_iterator *m_prev{
nullptr}, *m_next{
nullptr};
447 #include "pqxx/internal/compiler-internal-post.hxx"
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:26
int result_difference_type
Difference between result sizes.
Definition: types.hxx:21
int result_size_type
Number of rows in a result set.
Definition: types.hxx:18
Definition: connection.hxx:98
Connection to a database.
Definition: connection.hxx:184
Common definitions for cursor types.
Definition: cursor.hxx:41
cursor_base & operator=(cursor_base const &)=delete
static difference_type backward_all() noexcept
Special value: read backwards from current position back to origin.
Definition: cursor.cxx:32
static difference_type prior() noexcept
Special value: read backwards, one row only.
Definition: cursor.hxx:117
result_size_type size_type
Definition: cursor.hxx:43
cursor_base(cursor_base const &)=delete
access_policy
Cursor access-pattern policy.
Definition: cursor.hxx:51
@ forward_only
Cursor can move forward only.
Definition: cursor.hxx:53
ownership_policy
Cursor destruction policy.
Definition: cursor.hxx:87
@ owned
Destroy SQL cursor when cursor object is closed at end of transaction.
Definition: cursor.hxx:89
update_policy
Cursor update policy.
Definition: cursor.hxx:63
@ read_only
Cursor can be used to read data but not to write.
Definition: cursor.hxx:65
result_difference_type difference_type
Definition: cursor.hxx:44
std::string const m_name
Definition: cursor.hxx:137
"Stateless cursor" class: easy API for retrieving parts of result sets
Definition: cursor.hxx:156
std::string const & name() const noexcept
Return this cursor's name.
Definition: cursor.hxx:207
void close() noexcept
Close this cursor. The destructor will do this automatically.
Definition: cursor.hxx:177
stateless_cursor(transaction_base &trans, std::string_view adopted_cursor)
Adopt existing scrolling SQL cursor.
Definition: cursor.hxx:169
result_size_type size_type
Definition: cursor.hxx:158
result_difference_type difference_type
Definition: cursor.hxx:159
result retrieve(difference_type begin_pos, difference_type end_pos)
Retrieve rows from begin_pos (inclusive) to end_pos (exclusive)
Definition: cursor.hxx:200
stateless_cursor(transaction_base &trans, std::string_view query, std::string_view cname, bool hold)
Create cursor.
Definition: cursor.hxx:162
size_type size()
Number of rows in cursor's result set.
Definition: cursor.hxx:183
Simple read-only cursor represented as a stream of results.
Definition: cursor.hxx:247
icursorstream & get(result &res)
Read new value into given result object; same as operator >>
Definition: cursor.hxx:307
cursor_base::size_type size_type
Definition: cursor.hxx:249
difference_type stride() const noexcept
Definition: cursor.hxx:333
icursorstream & operator>>(result &res)
Read new value into given result object; same as get(result &)
Definition: cursor.hxx:319
cursor_base::difference_type difference_type
Definition: cursor.hxx:250
Approximate istream_iterator for icursorstream.
Definition: cursor.hxx:384
result const * operator->() const
Definition: cursor.hxx:404
bool operator!=(icursor_iterator const &rhs) const noexcept
Definition: cursor.hxx:415
result const * pointer
Definition: cursor.hxx:388
bool operator>=(icursor_iterator const &rhs) const
Definition: cursor.hxx:428
bool operator>(icursor_iterator const &rhs) const
Definition: cursor.hxx:420
result const & reference
Definition: cursor.hxx:389
istream_type::difference_type difference_type
Definition: cursor.hxx:392
std::input_iterator_tag iterator_category
Definition: cursor.hxx:386
bool operator<=(icursor_iterator const &rhs) const
Definition: cursor.hxx:424
istream_type::size_type size_type
Definition: cursor.hxx:391
Reference to a field in a result set.
Definition: field.hxx:34
Result set containing data returned by a query or command.
Definition: result.hxx:71
result_difference_type difference_type
Definition: result.hxx:74
Interface definition (and common code) for "transaction" classes.
Definition: transaction_base.hxx:75