16 #if !defined(PQXX_HEADER_PRE)
17 # error "Include libpqxx headers as <pqxx/header>, not <pqxx/header.hxx>."
23 #include "pqxx/result.hxx"
24 #include "pqxx/transaction_base.hxx"
110 return (std::numeric_limits<int>::max)() - 1;
131 return (std::numeric_limits<int>::min)() + 1;
142 [[nodiscard]] constexpr std::string
const &
name() const noexcept
155 #include <pqxx/internal/sql_cursor.hxx>
167 template<cursor_base::update_policy up, cursor_base::ownership_policy op>
186 m_cur{tx, query, cname,
cursor_base::random_access, up, op, hold}
197 m_cur{tx, adopted_cursor, op}
209 void close() noexcept { m_cur.close(); }
217 return internal::obtain_stateless_cursor_size(m_cur);
234 return internal::stateless_cursor_retrieve(
239 [[nodiscard]] constexpr std::string
const &
name() const noexcept
245 internal::sql_cursor m_cur;
249 class icursor_iterator;
255 class icursor_iterator_icursorstream;
256 class icursorstream_icursor_iterator;
330 constexpr
operator bool() const & noexcept {
return not m_done; }
370 void set_stride(difference_type stride) &;
379 friend class internal::gate::icursorstream_icursor_iterator;
386 internal::sql_cursor m_cur;
458 return not operator==(rhs);
467 return not(*
this > rhs);
471 return not(*
this < rhs);
475 void refresh()
const;
477 friend class internal::gate::icursor_iterator_icursorstream;
479 void fill(
result const &);
483 difference_type m_pos;
484 icursor_iterator *m_prev{
nullptr}, *m_next{
nullptr};
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:33
int result_difference_type
Difference between result sizes.
Definition: types.hxx:31
int result_size_type
Number of rows in a result set.
Definition: types.hxx:28
Definition: connection.hxx:109
Connection to a database.
Definition: connection.hxx:233
Common definitions for cursor types.
Definition: cursor.hxx:42
cursor_base & operator=(cursor_base const &)=delete
result_size_type size_type
Definition: cursor.hxx:44
constexpr std::string const & name() const noexcept
Name of underlying SQL cursor.
Definition: cursor.hxx:142
static constexpr difference_type next() noexcept
Special value: read one row only.
Definition: cursor.hxx:116
cursor_base(cursor_base const &)=delete
static constexpr difference_type all() noexcept
Special value: read until end.
Definition: cursor.hxx:108
static constexpr difference_type prior() noexcept
Special value: read backwards, one row only.
Definition: cursor.hxx:121
access_policy
Cursor access-pattern policy.
Definition: cursor.hxx:52
@ forward_only
Cursor can move forward only.
Definition: cursor.hxx:54
ownership_policy
Cursor destruction policy.
Definition: cursor.hxx:88
@ owned
Destroy SQL cursor when cursor object is closed at end of transaction.
Definition: cursor.hxx:90
update_policy
Cursor update policy.
Definition: cursor.hxx:64
@ read_only
Cursor can be used to read data but not to write.
Definition: cursor.hxx:66
result_difference_type difference_type
Definition: cursor.hxx:45
std::string const m_name
Definition: cursor.hxx:150
static constexpr difference_type backward_all() noexcept
Special value: read backwards from current position back to origin.
Definition: cursor.hxx:129
"Stateless cursor" class: easy API for retrieving parts of result sets
Definition: cursor.hxx:169
void close() noexcept
Close this cursor.
Definition: cursor.hxx:209
result_size_type size_type
Definition: cursor.hxx:171
result_difference_type difference_type
Definition: cursor.hxx:172
result retrieve(difference_type begin_pos, difference_type end_pos)
Retrieve rows from begin_pos (inclusive) to end_pos (exclusive)
Definition: cursor.hxx:232
constexpr std::string const & name() const noexcept
Return this cursor's name.
Definition: cursor.hxx:239
stateless_cursor(transaction_base &tx, std::string_view query, std::string_view cname, bool hold)
Create cursor.
Definition: cursor.hxx:183
size_type size()
Number of rows in cursor's result set.
Definition: cursor.hxx:215
stateless_cursor(transaction_base &tx, std::string_view adopted_cursor)
Adopt an existing scrolling SQL cursor.
Definition: cursor.hxx:196
Simple read-only cursor represented as a stream of results.
Definition: cursor.hxx:279
icursorstream & get(result &res)
Read new value into given result object; same as operator >>.
Definition: cursor.hxx:341
cursor_base::size_type size_type
Definition: cursor.hxx:281
icursorstream & operator>>(result &res)
Read new value into given result object; same as get(result&).
Definition: cursor.hxx:355
cursor_base::difference_type difference_type
Definition: cursor.hxx:282
constexpr difference_type stride() const noexcept
Definition: cursor.hxx:371
Approximate istream_iterator for icursorstream.
Definition: cursor.hxx:425
result const * operator->() const
Definition: cursor.hxx:445
bool operator!=(icursor_iterator const &rhs) const noexcept
Definition: cursor.hxx:456
result const * pointer
Definition: cursor.hxx:429
bool operator>=(icursor_iterator const &rhs) const
Definition: cursor.hxx:469
bool operator>(icursor_iterator const &rhs) const
Definition: cursor.hxx:461
result const & reference
Definition: cursor.hxx:430
istream_type::difference_type difference_type
Definition: cursor.hxx:433
std::input_iterator_tag iterator_category
Definition: cursor.hxx:427
bool operator<=(icursor_iterator const &rhs) const
Definition: cursor.hxx:465
istream_type::size_type size_type
Definition: cursor.hxx:432
Reference to a field in a result set.
Definition: field.hxx:35
Result set containing data returned by a query or command.
Definition: result.hxx:73
result_difference_type difference_type
Definition: result.hxx:76
Interface definition (and common code) for "transaction" classes.
Definition: transaction_base.hxx:88