RU

Struct mdbx::map_handle

ClassList > mdbx > map_handle

A handle for an individual table (aka key-value space, maps or sub-database) in the environment. More...

• #include <mdbx.h++>

Classes

Type	Name
struct	info Flags and state of a table (aka map).

Public Types

Type	Name
typedef ::MDBX_db_flags_t	flags An alias for MDBX_db_flags_t , i.e. the table flags.
typedef ::MDBX_dbi_state_t	state An alias for MDBX_dbi_state_t , i.e. the table state.

Public Attributes

Type	Name
MDBX_dbi	dbi = {0} The table handle (DBI) number; zero for the main table.

Public Functions

Type	Name
constexpr	map_handle () noexcept Constructs an invalid (empty) handle.
constexpr	map_handle (MDBX_dbi dbi) noexcept Constructs a handle from the given DBI number.
	map_handle (const map_handle &) noexcept Copy constructor.
	operator MDBX_dbi () const Returns the underlying DBI number.
map_handle &	operator= (const map_handle &) noexcept Copy assignment operator.

Detailed Description

See also: txn::open_map()

See also: txn::create_map()

See also: txn::clear_map()

See also: txn::drop_map()

See also: txn::get_map_flags()

See also: txn::get_map_stat()

See also: env::close_map()

See also: cursor::map()

Public Types Documentation

typedef flags

An alias for MDBX_db_flags_t , i.e. the table flags.

using mdbx::map_handle::flags = ::MDBX_db_flags_t;

---

typedef state

An alias for MDBX_dbi_state_t , i.e. the table state.

using mdbx::map_handle::state = ::MDBX_dbi_state_t;

---

Public Attributes Documentation

variable dbi

The table handle (DBI) number; zero for the main table.

MDBX_dbi mdbx::map_handle::dbi;

---

Public Functions Documentation

function map_handle [1/3]

Constructs an invalid (empty) handle.

inline constexpr mdbx::map_handle::map_handle () noexcept

---

function map_handle [2/3]

Constructs a handle from the given DBI number.

inline constexpr mdbx::map_handle::map_handle (
    MDBX_dbi dbi
) noexcept

Parameters:

• dbi The table handle (DBI) number.

---

function map_handle [3/3]

Copy constructor.

mdbx::map_handle::map_handle (
    const map_handle &
) noexcept

---

function operator MDBX_dbi

Returns the underlying DBI number.

inline mdbx::map_handle::operator MDBX_dbi () const

Returns:

The table handle (DBI) number.

---

function operator=

Copy assignment operator.

map_handle & mdbx::map_handle::operator= (
    const map_handle &
) noexcept

Returns:

A reference to this instance.

---

Friends Documentation

friend operator!=

inline bool mdbx::map_handle::operator!= (
    const map_handle & a,
    const map_handle & b
) noexcept

---

friend operator<

inline bool mdbx::map_handle::operator< (
    const map_handle & a,
    const map_handle & b
) noexcept

---

friend operator<=

inline bool mdbx::map_handle::operator<= (
    const map_handle & a,
    const map_handle & b
) noexcept

---

friend operator==

inline bool mdbx::map_handle::operator== (
    const map_handle & a,
    const map_handle & b
) noexcept

---

friend operator>

inline bool mdbx::map_handle::operator> (
    const map_handle & a,
    const map_handle & b
) noexcept

---

friend operator>=

inline bool mdbx::map_handle::operator>= (
    const map_handle & a,
    const map_handle & b
) noexcept

---

---

The documentation for this class was generated from the following file mdbx.h++