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>
170 m_cur{trans, adopted_cursor, op}
176 void close() noexcept { m_cur.close(); }
184 return internal::obtain_stateless_cursor_size(m_cur);
201 return internal::stateless_cursor_retrieve(
205 [[nodiscard]] std::string
const &
name() const noexcept
211 internal::sql_cursor m_cur;
215 class icursor_iterator;
221 class icursor_iterator_icursorstream;
222 class icursorstream_icursor_iterator;
295 operator bool() const noexcept {
return not m_done; }
329 void set_stride(difference_type stride);
335 friend class internal::gate::icursorstream_icursor_iterator;
342 internal::sql_cursor m_cur;
414 return not operator==(rhs);
423 return not(*
this > rhs);
427 return not(*
this < rhs);
431 void refresh()
const;
433 friend class internal::gate::icursor_iterator_icursorstream;
435 void fill(
result const &);
439 difference_type m_pos;
440 icursor_iterator *m_prev{
nullptr}, *m_next{
nullptr};
444 #include "pqxx/internal/compiler-internal-post.hxx"
difference_type stride() const noexcept
Definition: cursor.hxx:330
int result_size_type
Number of rows in a result set.
Definition: types.hxx:18
result_size_type size_type
Definition: cursor.hxx:158
@ forward_only
Cursor can move forward only.
Definition: cursor.hxx:53
bool operator==(icursor_iterator const &rhs) const
Definition: cursor.cxx:299
"Stateless cursor" class: easy API for retrieving parts of result sets
Definition: cursor.hxx:156
stateless_cursor(transaction_base &trans, std::string_view query, std::string_view cname, bool hold)
Create cursor.
Definition: cursor.hxx:162
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:26
static difference_type backward_all() noexcept
Special value: read backwards from current position back to origin.
Definition: cursor.cxx:32
void close() noexcept
Definition: cursor.hxx:176
@ random_access
Cursor can move back and forth.
Definition: cursor.hxx:55
Definition: connection.hxx:95
@ owned
Destroy SQL cursor when cursor object is closed at end of transaction.
Definition: cursor.hxx:89
result_size_type size_type
Definition: cursor.hxx:43
Common definitions for cursor types.
Definition: cursor.hxx:41
void set_stride(difference_type stride)
Change stride, i.e. the number of rows to fetch per read operation.
Definition: cursor.cxx:111
icursorstream & get(result &res)
Read new value into given result object; same as operator >>
Definition: cursor.hxx:304
std::input_iterator_tag iterator_category
Definition: cursor.hxx:383
bool operator!=(icursor_iterator const &rhs) const noexcept
Definition: cursor.hxx:412
result const * pointer
Definition: cursor.hxx:385
icursor_iterator & operator+=(difference_type)
Definition: cursor.cxx:259
Invalid argument passed to libpqxx, similar to std::invalid_argument.
Definition: except.hxx:172
icursorstream & ignore(std::streamsize n=1)
Move given number of rows forward (ignoring stride) without reading data.
Definition: cursor.cxx:130
Connection to a database.
Definition: connection.hxx:164
int result_difference_type
Difference between result sizes.
Definition: types.hxx:21
PQXX_PURE char const * c_str() const
Read as plain C string.
Definition: field.cxx:60
Reference to a field in a result set.
Definition: field.hxx:34
static difference_type all() noexcept
Special value: read until end.
Definition: cursor.cxx:24
bool operator<(icursor_iterator const &rhs) const
Definition: cursor.cxx:311
~icursor_iterator() noexcept
Definition: cursor.cxx:232
icursorstream & operator>>(result &res)
Read new value into given result object; same as get(result &)
Definition: cursor.hxx:316
stateless_cursor(transaction_base &trans, std::string_view adopted_cursor)
Adopt existing scrolling SQL cursor.
Definition: cursor.hxx:169
std::string adorn_name(std::string_view)
Suffix unique number to name to make it unique within session context.
Definition: connection.cxx:1027
result_difference_type difference_type
Definition: result.hxx:74
cursor_base & operator=(cursor_base const &)=delete
icursor_iterator() noexcept
Definition: cursor.cxx:209
result const * operator->() const
Definition: cursor.hxx:401
icursor_iterator & operator++()
Definition: cursor.cxx:250
Approximate istream_iterator for icursorstream.
Definition: cursor.hxx:381
access_policy
Cursor access-pattern policy.
Definition: cursor.hxx:51
Interface definition (and common code) for "transaction" classes.
Definition: transaction_base.hxx:72
std::string const m_name
Definition: cursor.hxx:137
cursor_base::difference_type difference_type
Definition: cursor.hxx:248
size_type size()
Number of rows in cursor's result set.
Definition: cursor.hxx:182
bool operator>=(icursor_iterator const &rhs) const
Definition: cursor.hxx:425
result_size_type size_type
Definition: result.hxx:73
istream_type::size_type size_type
Definition: cursor.hxx:388
update_policy
Cursor update policy.
Definition: cursor.hxx:63
istream_type::difference_type difference_type
Definition: cursor.hxx:389
result const & reference
Definition: cursor.hxx:386
icursorstream(transaction_base &context, std::string_view query, std::string_view basename, difference_type sstride=1)
Set up a read-only, forward-only cursor.
Definition: cursor.cxx:76
cursor_base::size_type size_type
Definition: cursor.hxx:247
result retrieve(difference_type begin_pos, difference_type end_pos)
Retrieve rows from begin_pos (inclusive) to end_pos (exclusive)
Definition: cursor.hxx:199
icursor_iterator & operator=(icursor_iterator const &) noexcept
Definition: cursor.cxx:276
@ 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
static difference_type prior() noexcept
Special value: read backwards, one row only.
Definition: cursor.hxx:117
Simple read-only cursor represented as a stream of results.
Definition: cursor.hxx:245
bool operator<=(icursor_iterator const &rhs) const
Definition: cursor.hxx:421
std::string const & name() const noexcept
Definition: cursor.hxx:205
Result set containing data returned by a query or command.
Definition: result.hxx:71
result_difference_type difference_type
Definition: cursor.hxx:159
ownership_policy
Cursor destruction policy.
Definition: cursor.hxx:87
bool operator>(icursor_iterator const &rhs) const
Definition: cursor.hxx:417
cursor_base(cursor_base const &)=delete