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" 107 [[nodiscard]]
static difference_type all() noexcept;
122 [[nodiscard]]
static difference_type backward_all() noexcept;
132 [[nodiscard]] std::
string const &name() const noexcept {
return m_name; }
135 cursor_base(connection &, std::string_view Name,
bool embellish_name =
true);
142 #include <pqxx/internal/sql_cursor.hxx> 154 template<cursor_base::update_policy up, cursor_base::ownership_policy op>
163 transaction_base &trans, std::string_view query, std::string_view cname,
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(
202 m_cur, result::difference_type(
size()), begin_pos, end_pos);
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;
263 transaction_base &context, std::string_view query,
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;
396 result const &operator*()
const 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" icursorstream & operator>>(result &res)
Read new value into given result object; same as get(result &)
Definition: cursor.hxx:316
bool operator<=(icursor_iterator const &rhs) const
Definition: cursor.hxx:421
int result_difference_type
Difference between result sizes.
Definition: types.hxx:21
Approximate istream_iterator for icursorstream.
Definition: cursor.hxx:380
std::string const & name() const noexcept
Definition: cursor.hxx:205
Definition: cursor.hxx:219
ownership_policy
Cursor destruction policy.
Definition: cursor.hxx:86
icursorstream & get(result &res)
Read new value into given result object; same as operator >>
Definition: cursor.hxx:304
result value_type
Definition: cursor.hxx:384
Cursor can be used to read data but not to write.
Definition: cursor.hxx:65
cursor_base::size_type size_type
Definition: cursor.hxx:247
result_difference_type difference_type
Definition: cursor.hxx:159
void close() noexcept
Definition: cursor.hxx:176
result_size_type size_type
Definition: cursor.hxx:43
result_difference_type difference_type
Definition: cursor.hxx:44
access_policy
Cursor access-pattern policy.
Definition: cursor.hxx:50
result const & reference
Definition: cursor.hxx:386
difference_type stride() const noexcept
Definition: cursor.hxx:330
Reference to a field in a result set.
Definition: field.hxx:32
Simple read-only cursor represented as a stream of results.
Definition: cursor.hxx:244
static difference_type prior() noexcept
Special value: read backwards, one row only.
Definition: cursor.hxx:117
std::string const m_name
Definition: cursor.hxx:137
update_policy
Cursor update policy.
Definition: cursor.hxx:62
istream_type::size_type size_type
Definition: cursor.hxx:388
result_size_type size_type
Definition: cursor.hxx:158
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
Cursor can move back and forth.
Definition: cursor.hxx:55
istream_type::difference_type difference_type
Definition: cursor.hxx:389
int result_size_type
Number of rows in a result set.
Definition: types.hxx:18
std::input_iterator_tag iterator_category
Definition: cursor.hxx:383
Common definitions for cursor types.
Definition: cursor.hxx:40
cursor_base::difference_type difference_type
Definition: cursor.hxx:248
result const * operator->() const
Definition: cursor.hxx:401
bool operator>(icursor_iterator const &rhs) const
Definition: cursor.hxx:417
Dedicated namespace for helper types related to prepared statements.
Definition: array.hxx:25
stateless_cursor(transaction_base &trans, std::string_view adopted_cursor)
Adopt existing scrolling SQL cursor.
Definition: cursor.hxx:169
stateless_cursor(transaction_base &trans, std::string_view query, std::string_view cname, bool hold)
Create cursor.
Definition: cursor.hxx:162
Cursor can move forward only.
Definition: cursor.hxx:53
result retrieve(difference_type begin_pos, difference_type end_pos)
Retrieve rows from begin_pos (inclusive) to end_pos (exclusive)
Definition: cursor.hxx:199
static difference_type backward_all() noexcept
Special value: read backwards from current position back to origin.
Definition: cursor.cxx:32
"Stateless cursor" class: easy API for retrieving parts of result sets
Definition: cursor.hxx:155
Destroy SQL cursor when cursor object is closed at end of transaction.
Definition: cursor.hxx:89
bool operator!=(icursor_iterator const &rhs) const noexcept
Definition: cursor.hxx:412
result const * pointer
Definition: cursor.hxx:385