Function lmdb_master_sys::mdb_env_copyfd2

source · 
pub unsafe extern "C" fn mdb_env_copyfd2(
    env: *mut MDB_env,
    fd: mdb_filehandle_t,
    flags: c_uint,
) -> c_int
Expand description

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

This function may be used to make a backup of an existing environment. No lockfile is created, since it gets recreated at need. See #mdb_env_copy2() for further details.

Note: This call can trigger significant file size growth if run in parallel with write transactions, because it employs a read-only transaction. See long-lived transactions under caveats_sec.

§Arguments

  • env (direction in) - An environment handle returned by #mdb_env_create(). It must have already been opened successfully.
  • fd (direction in) - The filedescriptor to write the copy to. It must have already been opened for Write access.
  • flags (direction in) - Special options for this operation. See #mdb_env_copy2() for options.

§Returns

A non-zero error value on failure and 0 on success.