Berkeley DB: Db::set_bt_minkey
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++

Db::set_bt_minkey |

`

    #include <db_cxx.h>

    int
    Db::set_bt_minkey(u_int32_t bt_minkey);

    int
    Db::get_bt_minkey(u_int32_t *bt_minkeyp);

Description: Db::set_bt_minkey

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 method may not be called after the Db::open method 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.

Parameters
bt_minkey

- The bt_minkey parameter is the minimum number of key/data pairs intended to be stored on any single Btree leaf page.

Errors

The Db::set_bt_minkey method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

EINVAL

- If the method was called after Db::open was called; or if an invalid flag value or parameter was specified.

Description: Db::get_bt_minkey

The Db::get_bt_minkey method returns the minimum number of key/data pairs intended to be stored on any single Btree leaf page.

The Db::get_bt_minkey method may be called at any time during the life of the application.

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

Parameters
bt_minkeyp

- The Db::get_bt_minkey method returns the minimum number of key/data pairs intended to be stored on any single Btree leaf page in bt_minkeyp.

Class Db
See Also Databases and Related Methods`

Copyright (c) 1996,2008 Oracle. All rights reserved.