libpqxx
The C++ client library for PostgreSQL
|
Common definitions for cursor types. More...
Public Types | |
enum | access_policy { forward_only , random_access } |
Cursor access-pattern policy. More... | |
enum | update_policy { read_only , update } |
Cursor update policy. More... | |
enum | ownership_policy { owned , loose } |
Cursor destruction policy. More... | |
using | size_type = result_size_type |
using | difference_type = result_difference_type |
Public Member Functions | |
cursor_base (cursor_base const &)=delete | |
cursor_base & | operator= (cursor_base const &)=delete |
Special movement distances. | |
std::string const | m_name |
constexpr std::string const & | name () const noexcept |
Name of underlying SQL cursor. | |
static constexpr difference_type | all () noexcept |
Special value: read until end. | |
static constexpr difference_type | next () noexcept |
Special value: read one row only. | |
static constexpr difference_type | prior () noexcept |
Special value: read backwards, one row only. | |
static constexpr difference_type | backward_all () noexcept |
Special value: read backwards from current position back to origin. | |
cursor_base (connection &, std::string_view Name, bool embellish_name=true) | |
Common definitions for cursor types.
In C++ terms, fetches are always done in pre-increment or pre-decrement fashion–i.e. the result does not include the row the cursor is on at the beginning of the fetch, and the cursor ends up being positioned on the last row in the result.
There are singular positions akin to end()
at both the beginning and the end of the cursor's range of movement, although these fit in so naturally with the semantics that one rarely notices them. The cursor begins at the first of these, but any fetch in the forward direction will move the cursor off this position and onto the first row before returning anything.
Cursor destruction policy.
The normal thing to do is to make a cursor object the owner of the SQL cursor it represents. There may be cases, however, where a cursor needs to persist beyond the end of the current transaction (and thus also beyond the lifetime of the cursor object that created it!), where it can be "adopted" into a new cursor object. See the basic_cursor documentation for an explanation of cursor adoption.
If a cursor is created with "loose" ownership policy, the object representing the underlying SQL cursor will not take the latter with it when its own lifetime ends, nor will its originating transaction.
Enumerator | |
---|---|
owned | Destroy SQL cursor when cursor object is closed at end of transaction. |
loose | Leave SQL cursor in existence after close of object and transaction. |
|
protected |
Implementation of libpqxx STL-style cursor classes.
These classes wrap SQL cursors in STL-like interfaces.
Copyright (c) 2000-2024, Jeroen T. Vermeulen.
See COPYING for copyright license. If you did not receive a file called COPYING with this source code, please notify the distributor of this mistake, or contact the author.
|
inlinestaticconstexprnoexcept |
Special value: read until end.
|
inlinestaticconstexprnoexcept |
Special value: read backwards from current position back to origin.
|
inlineconstexprnoexcept |
Name of underlying SQL cursor.
|
inlinestaticconstexprnoexcept |
Special value: read one row only.
|
inlinestaticconstexprnoexcept |
Special value: read backwards, one row only.