ISAR/libmdbx
3
0
Fork 0
mirror of https://github.com/isar/libmdbx.git synced 2025-09-11 14:02:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

mdbx-doc: clarify description of mdbx_dbi_sequence().

Browse Source
This commit is contained in:
Леонид Юрьев (Leonid Yuriev)
2025-09-05 23:53:20 +03:00
parent 222d8f13f8
commit fc4c02511d
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
mdbx.h
View File

@@ -6043,11 +6043,10 @@ MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_is_dirty(const MDBX_txn *txn, co
/** \brief Sequence generation for a table. /** \brief Sequence generation for a table.
* \ingroup c_crud * \ingroup c_crud
* *
* The function allows to create a linear sequence of unique positive integers * The function provides a linear sequence of unique positive integers for each table with acquire/allocate semantics.
* for each table. The function can be called for a read transaction to * The function can be called for a read transaction to retrieve the current sequence value while the increment must be
* retrieve the current sequence value, and the increment must be zero. * zero. Sequence changes become visible outside the current write transaction after it is committed, and discarded on
* Sequence changes become visible outside the current write transaction after * abort.
* it is committed, and discarded on abort.
* *
* \param [in] txn A transaction handle returned * \param [in] txn A transaction handle returned
* by \ref mdbx_txn_begin(). * by \ref mdbx_txn_begin().
@@ -6060,7 +6059,7 @@ MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_is_dirty(const MDBX_txn *txn, co
* \returns A non-zero error value on failure and 0 on success, * \returns A non-zero error value on failure and 0 on success,
* some possible errors are: * some possible errors are:
* \retval MDBX_RESULT_TRUE Increasing the sequence has resulted in an * \retval MDBX_RESULT_TRUE Increasing the sequence has resulted in an
* overflow and therefore cannot be executed. */ * overflow and therefore cannot be performed. */
LIBMDBX_API int mdbx_dbi_sequence(MDBX_txn *txn, MDBX_dbi dbi, uint64_t *result, uint64_t increment); LIBMDBX_API int mdbx_dbi_sequence(MDBX_txn *txn, MDBX_dbi dbi, uint64_t *result, uint64_t increment);
/** \brief Compare two keys according to a particular table. /** \brief Compare two keys according to a particular table.