Crate lmdb_sys

source · [−]

Structs

@brief Information about the environment

@brief Statistics for a database in the environment

@brief Generic structure used for passing keys and data in and out of the database.

Constants

MDB_BAD_VALSIZE

MDB_CURSOR_FULL

< Position at first key/data item

< Position at first data item of current key. Only for #MDB_DUPSORT

< Position at key/data pair. Only for #MDB_DUPSORT

MDB_GET_BOTH_RANGE

< position at key, nearest data. Only for #MDB_DUPSORT

MDB_GET_CURRENT

< Return key/data at current cursor position

MDB_GET_MULTIPLE

< Return up to a page of duplicate data items from current cursor position. Move cursor to prepare for #MDB_NEXT_MULTIPLE. Only for #MDB_DUPFIXED

MDB_INCOMPATIBLE

< Position at last key/data item

< Position at last data item of current key. Only for #MDB_DUPSORT

MDB_LAST_ERRCODE

MDB_MAP_RESIZED

< Position at next data item

< Position at next data item of current key. Only for #MDB_DUPSORT

MDB_NEXT_MULTIPLE

< Return up to a page of duplicate data items from next cursor position. Move cursor to prepare for #MDB_NEXT_MULTIPLE. Only for #MDB_DUPFIXED

< Position at first data item of next key

MDB_NOOVERWRITE

MDB_PAGE_NOTFOUND

< Position at previous data item

< Position at previous data item of current key. Only for #MDB_DUPSORT

MDB_PREV_MULTIPLE

< Position at previous page and return up to a page of duplicate data items. Only for #MDB_DUPFIXED

< Position at last data item of previous key

MDB_READERS_FULL

< Position at specified key

< Position at specified key, return key + data

< Position at first key greater than or equal to specified key.

MDB_VERSION_DATE

MDB_VERSION_MAJOR

MDB_VERSION_MINOR

MDB_VERSION_MISMATCH

MDB_VERSION_PATCH

Functions

@brief Compare two data items according to a particular database.

mdb_cursor_close ^⚠

@brief Close a cursor handle.

mdb_cursor_count ^⚠

@brief Return count of duplicates for current key.

mdb_cursor_dbi ^⚠

@brief Return the cursor’s database handle.

mdb_cursor_del ^⚠

@brief Delete current key/data pair

mdb_cursor_get ^⚠

@brief Retrieve by cursor.

mdb_cursor_open ^⚠

@brief Create a cursor handle.

mdb_cursor_put ^⚠

@brief Store by cursor.

mdb_cursor_renew ^⚠

@brief Renew a cursor handle.

mdb_cursor_txn ^⚠

@brief Return the cursor’s transaction handle.

mdb_dbi_close ^⚠

@brief Close a database handle. Normally unnecessary. Use with care:

mdb_dbi_flags ^⚠

@brief Retrieve the DB flags for a database handle.

mdb_dbi_open ^⚠

@brief Open a database in the environment.

@brief Compare two data items according to a particular database.

@brief Delete items from a database.

@brief Empty or delete+close a database.

mdb_env_close ^⚠

@brief Close the environment and release the memory map.

mdb_env_copy ^⚠

@brief Copy an LMDB environment to the specified path.

mdb_env_copy2 ^⚠

@brief Copy an LMDB environment to the specified path, with options.

mdb_env_copyfd ^⚠

@brief Copy an LMDB environment to the specified file descriptor.

mdb_env_copyfd2 ^⚠

@brief Copy an LMDB environment to the specified file descriptor, with options.

mdb_env_create ^⚠

@brief Create an LMDB environment handle.

mdb_env_get_fd ^⚠

@brief Return the filedescriptor for the given environment.

mdb_env_get_flags ^⚠

@brief Get environment flags.

mdb_env_get_maxkeysize ^⚠

@brief Get the maximum size of keys and #MDB_DUPSORT data we can write.

mdb_env_get_maxreaders ^⚠

@brief Get the maximum number of threads/reader slots for the environment.

mdb_env_get_path ^⚠

@brief Return the path that was used in #mdb_env_open().

mdb_env_get_userctx ^⚠

@brief Get the application information associated with the #MDB_env.

mdb_env_info ^⚠

@brief Return information about the LMDB environment.

mdb_env_open ^⚠

@brief Open an environment handle.

mdb_env_set_assert ^⚠

Set or reset the assert() callback of the environment. Disabled if liblmdb is buillt with NDEBUG. @note This hack should become obsolete as lmdb’s error handling matures. @param[in] env An environment handle returned by #mdb_env_create(). @param[in] func An #MDB_assert_func function, or 0. @return A non-zero error value on failure and 0 on success.

mdb_env_set_flags ^⚠

@brief Set environment flags.

mdb_env_set_mapsize ^⚠

@brief Set the size of the memory map to use for this environment.

mdb_env_set_maxdbs ^⚠

@brief Set the maximum number of named databases for the environment.

mdb_env_set_maxreaders ^⚠

@brief Set the maximum number of threads/reader slots for the environment.

mdb_env_set_userctx ^⚠

@brief Set application information associated with the #MDB_env.

mdb_env_stat ^⚠

@brief Return statistics about the LMDB environment.

mdb_env_sync ^⚠

@brief Flush the data buffers to disk.

@brief Get items from a database.

@brief Store items into a database.

mdb_reader_check ^⚠

@brief Check for stale entries in the reader lock table.

mdb_reader_list ^⚠

@brief Dump the entries in the reader lock table.

mdb_set_compare ^⚠

@brief Set a custom key comparison function for a database.

mdb_set_dupsort ^⚠

@brief Set a custom data comparison function for a #MDB_DUPSORT database.

mdb_set_relctx ^⚠

@brief Set a context pointer for a #MDB_FIXEDMAP database’s relocation function.

mdb_set_relfunc ^⚠

@brief Set a relocation function for a #MDB_FIXEDMAP database.

@brief Retrieve statistics for a database.

mdb_strerror ^⚠

@brief Return a string describing a given error code.

mdb_txn_abort ^⚠

@brief Abandon all the operations of the transaction instead of saving them.

mdb_txn_begin ^⚠

@brief Create a transaction for use with the environment.

mdb_txn_commit ^⚠

@brief Commit all the operations of a transaction into the database.

mdb_txn_env ^⚠

@brief Returns the transaction’s #MDB_env

mdb_txn_id ^⚠

@brief Return the transaction’s ID.

mdb_txn_renew ^⚠

@brief Renew a read-only transaction.

mdb_txn_reset ^⚠

@brief Reset a read-only transaction.

mdb_version ^⚠

@brief Return the LMDB library version information.

Type Definitions

MDB_assert_func

@brief A callback function for most LMDB assert() failures, called before printing the message and aborting.

@brief A callback function used to compare two keys in a database

@brief Cursor Get operations.

@brief A handle for an individual database in the DB environment.

@brief A callback function used to print a message from the library.

@brief A callback function used to relocate a position-dependent data item in a fixed-address database.

mdb_filehandle_t