# Db::set_bt_minkey

`

###

    #include <db_cxx.h>

    int
    Db::set_bt_minkey(u_int32_t bt_minkey);

# Description

Set the minimum number of key/data pairs intended to be stored on any single Btree leaf page.

This value is used to determine if key or data items will be stored on overflow pages instead of Btree leaf pages. For more information on the specific algorithm used, see Minimum keys per page. The bt_minkey value specified must be at least 2; if bt_minkey is not explicitly set, a value of 2 is used.

The Db::set_bt_minkey method configures a database, not only operations performed using the specified Db handle.

The Db::set_bt_minkey interface may not be called after the Db::open interface is called. If the database already exists when Db::open is called, the information specified to Db::set_bt_minkey will be ignored.

The Db::set_bt_minkey 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.

# Errors

The Db::set_bt_minkey 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 Db::open was called.

The Db::set_bt_minkey 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 Db::set_bt_minkey method may fail and either return DB_RUNRECOVERY or throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

Db

# See Also

Databases and Related Methods`

Copyright Sleepycat Software