Berkeley DB: DbEnv::set_lk_max
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# DbEnv::set_lk_max |

`

###

    #include <db_cxx.h>

    int
    DbEnv::set_lk_max(u_int32_t max);

# Description

The DbEnv::set_lk_max method interface has been deprecated in favor of the DbEnv::set_lk_max_locks, DbEnv::set_lk_max_lockers, and DbEnv::set_lk_max_objects methods. Please update your applications.

Set each of the maximum number of locks, lockers, and lock objects supported by the Berkeley DB lock subsystem to max. This value is used by DbEnv::open to estimate how much space to allocate for various lock-table data structures. For specific information on configuring the size of the lock subsystem, see Configuring locking: sizing the system.

The DbEnv::set_lk_max interface may be used only to configure Berkeley DB before the DbEnv::open interface is called.

The DbEnv::set_lk_max method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success.

The database environment's maximum number of locks may also be set using the environment's DB_CONFIG file. The syntax of the entry in that file is a single line with the string "set_lk_max", one or more whitespace characters, and the number of locks. Because the DB_CONFIG file is read when the database environment is opened, it will silently overrule configuration done before that time.

# Errors

The DbEnv::set_lk_max method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

  Called after DbEnv::open was called.

The DbEnv::set_lk_max method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the DbEnv::set_lk_max method may fail and either return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

DbEnv, DbLock

# See Also

DbEnv::set_lk_conflicts, DbEnv::set_lk_detect, DbEnv::set_lk_max, DbEnv::set_lk_max_lockers, DbEnv::set_lk_max_locks, DbEnv::set_lk_max_objects, DbEnv::lock_detect, DbEnv::lock_get, DbEnv::lock_id, DbLock::put, DbEnv::lock_stat, and DbEnv::lock_vec.`

Copyright Sleepycat Software