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

mdbx: notes about free/reuse cursors.

Browse Source
This commit is contained in:
Leo Yuriev 2017-02-15 19:50:23 +03:00
parent 6f600845f3
commit acdaeeab5c
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
lmdb.h
View File

@ -1039,8 +1039,16 @@ size_t mdb_txn_id(MDB_txn *txn);
*
* The transaction handle is freed. It and its cursors must not be used
* again after this call, except with #mdb_cursor_renew().
* @note Earlier documentation incorrectly said all cursors would be freed.
*
* @note MDBX-mode:
* A cursor must be closed explicitly always, before
* or after its transaction ends. It can be reused with
* #mdb_cursor_renew() before finally closing it.
*
* @note LMDB-compatible mode:
* Earlier documentation incorrectly said all cursors would be freed.
* Only write-transactions free cursors.
*
* @param[in] txn A transaction handle returned by #mdb_txn_begin()
* @return A non-zero error value on failure and 0 on success. Some possible
* errors are:
@ -1057,8 +1065,16 @@ int mdb_txn_commit(MDB_txn *txn);
*
* The transaction handle is freed. It and its cursors must not be used
* again after this call, except with #mdb_cursor_renew().
* @note Earlier documentation incorrectly said all cursors would be freed.
*
* @note MDBX-mode:
* A cursor must be closed explicitly always, before
* or after its transaction ends. It can be reused with
* #mdb_cursor_renew() before finally closing it.
*
* @note LMDB-compatible mode:
* Earlier documentation incorrectly said all cursors would be freed.
* Only write-transactions free cursors.
*
* @param[in] txn A transaction handle returned by #mdb_txn_begin()
*/
int mdb_txn_abort(MDB_txn *txn);