Struct mdbx::env::operate_parameters

ClassList > mdbx > env > operate_parameters

Operate parameters.

#include <mdbx.h++>

Public Attributes

Type	Name
env::durability	durability = `/* multi line expression /` The durability level, see* env::durability .
unsigned	max_maps = `{0}` The maximum number of named tables/maps for the environment. Zero means default value.
unsigned	max_readers = `{0}` The maximum number of threads/reader slots for the environment. Zero means default value.
env::mode	mode = `{env::mode::write\_mapped\_io}` The operation mode, see env::mode .
env::operate_options	options The other operate options.
env::reclaiming_options	reclaiming The garbage reclaiming options.

Public Functions

Type	Name
MDBX_NODISCARD MDBX_env_flags_t	make_flags (bool accede=true, bool use_subdirectory=false) const Makes the MDBX_env_flags_t combination from these parameters.
constexpr	operate_parameters () noexcept Constructs the default operate parameters.
constexpr	operate_parameters (const unsigned max_maps, const unsigned max_readers=0, const env::mode mode=env::mode::write_mapped_io, env::durability durability=env::durability::robust_synchronous, const env::reclaiming_options & reclaiming=env::reclaiming_options(), const env::operate_options & options=env::operate_options()) noexcept Constructs the operate parameters.
constexpr	operate_parameters (const operate_parameters &) noexcept Copy constructor.
bool	operator!= (const operate_parameters & other) noexcept const
operate_parameters &	operator= (const operate_parameters &) noexcept Copy assignment operator.
bool	operator== (const operate_parameters & other) noexcept const

Public Static Functions

Type	Name
MDBX_NODISCARD env::durability	durability_from_flags (MDBX_env_flags_t flags) noexcept Extracts the durability level from environment flags.
MDBX_NODISCARD env::mode	mode_from_flags (MDBX_env_flags_t flags) noexcept Extracts the operation mode from environment flags.

Public Attributes Documentation

variable durability

The durability level, see env::durability .

env::durability mdbx::env::operate_parameters::durability;

variable max_maps

The maximum number of named tables/maps for the environment. Zero means default value.

unsigned mdbx::env::operate_parameters::max_maps;

variable max_readers

The maximum number of threads/reader slots for the environment. Zero means default value.

unsigned mdbx::env::operate_parameters::max_readers;

variable mode

The operation mode, see env::mode .

env::mode mdbx::env::operate_parameters::mode;

variable options

The other operate options.

env::operate_options mdbx::env::operate_parameters::options;

variable reclaiming

The garbage reclaiming options.

env::reclaiming_options mdbx::env::operate_parameters::reclaiming;

Public Functions Documentation

function make_flags

Makes the MDBX_env_flags_t combination from these parameters.

MDBX_NODISCARD  MDBX_env_flags_t mdbx::env::operate_parameters::make_flags (
    bool accede=true,
    bool use_subdirectory=false
) const

Parameters:

accede Allows accepting incompatible operating options in case the database is already being used by another process(es),

See also: MDBX_ACCEDE

Parameters:

use_subdirectory Use a subdirectory to place the DB files.

Returns:

The MDBX_env_flags_t combination.

function operate_parameters [1/3]

Constructs the default operate parameters.

inline constexpr mdbx::env::operate_parameters::operate_parameters () noexcept

function operate_parameters [2/3]

Constructs the operate parameters.

inline constexpr mdbx::env::operate_parameters::operate_parameters (
    const unsigned max_maps,
    const unsigned max_readers=0,
    const env::mode mode=env::mode::write_mapped_io,
    env::durability durability=env::durability::robust_synchronous,
    const env::reclaiming_options & reclaiming=env::reclaiming_options (),
    const env::operate_options & options=env::operate_options ()
) noexcept

Parameters:

max_maps The maximum number of key-value maps (tables).
max_readers The maximum number of concurrent readers.
mode The operation mode, see env::mode.
durability The durability mode, see env::durability.
reclaiming The reclaiming options, see env::reclaiming_options.
options The other options, see env::operate_options.

function operate_parameters [3/3]

Copy constructor.

constexpr mdbx::env::operate_parameters::operate_parameters (
    const operate_parameters &
) noexcept

function operator!=

inline bool mdbx::env::operate_parameters::operator!= (
    const operate_parameters & other
) noexcept const

function operator=

Copy assignment operator.

operate_parameters & mdbx::env::operate_parameters::operator= (
    const operate_parameters &
) noexcept

Returns:

A reference to this instance.

function operator==

inline bool mdbx::env::operate_parameters::operator== (
    const operate_parameters & other
) noexcept const

Public Static Functions Documentation

function durability_from_flags

Extracts the durability level from environment flags.

static MDBX_NODISCARD  env::durability mdbx::env::operate_parameters::durability_from_flags (
    MDBX_env_flags_t flags
) noexcept

Parameters:

flags The MDBX_env_flags_t combination.

Returns:

The corresponding env::durability.

function mode_from_flags

Extracts the operation mode from environment flags.

static MDBX_NODISCARD  env::mode mdbx::env::operate_parameters::mode_from_flags (
    MDBX_env_flags_t flags
) noexcept

Parameters:

flags The MDBX_env_flags_t combination.

Returns:

The corresponding env::mode.

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