Berkeley DB: Db::get
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btr ee,hash,hashing,transaction,transactions,locking,logging,access method,access me thods,java,C,C++

# Db::get

`

###

    #include <db_cxx.h>

    int
    Db::get(DbTxn *txnid, Dbt *key, Dbt *data, u_int32_t flags);

# Description

The Db::get method retrieves key/data pairs from the database. The address and length of the data associated with the specified key are returned in the structure referenced by data.

In the presence of duplicate key values, Db::get will return the first data item for the designated key. Duplicates are sorted by insert order except where this order has been overridden by cursor operations. Retrieval of duplicates requires the use of cursor operations. See Dbc::get for details.

If the file is being accessed under transaction protection, the txnid parameter is a transaction ID returned from DbTxnMgr::begin, otherwise, NULL.

The flags parameter must be set to 0 or one of the following values:

DB_GET_BOTH
  Retrieve the key/data pair only if both the key and data match the arguments.

DB_SET_RECNO
  Retrieve the specified numbered key/data pair from a database. Upon return, both the key and data items will have been filled in, not just the data item as is done for all other uses of the Db::get method.

  The data field of the specified key must be a pointer to a logical record number (i.e., a db_recno_t). This record number determines the record to be retrieved.

  For DB_SET_RECNO to be specified, the underlying database must be of type btree and it must have been created with the DB_RECNUM flag.

In addition, the following value may be set by logically OR'ing it into the flags parameter:

DB_RMW
  Acquire write locks instead of read locks when doing the retrieval. Setting this flag may decrease the likelihood of deadlock during a read-modify-write cycle by immediately acquiring the write lock during the read part of the cycle so that another thread of control acquiring a read lock for the same item, in its own read-modify-write cycle, will not result in deadlock.

If the database is a recno database and the requested key exists, but was never explicitly created by the application or was later deleted, the Db::get method returns DB_KEYEMPTY. Otherwise, if the requested key is not in the database, the Db::get function returns DB_NOTFOUND. Otherwise, the Db::get method either returns errno or throws an exception that encapsulates an errno on failure, and 0 on success.

# Errors

If a fatal error occurs in Berkeley DB, the Db::get method may fail and either return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY, at which point all subsequent database calls will also fail in the same way. Methods marked as returning errno will, by default, throw an exception that encapsulates the error information. The default error behavior can be changed, see DbException.

The Db::get method may fail and throw an exception for any of the errors specified for the following Berkeley DB and C library functions: Db::cursor, DBcursor->c_close(3), Dbc::get, fflush(3), fprintf(3), vfprintf(3), and vsnprintf(3).

In addition, the Db::get method may fail and throw an exception or return errno for the following conditions:

EAGAIN
  A lock was unavailable.

EINVAL
  An invalid flag value or parameter was specified.

  The DB_THREAD flag was specified to the Db::open method and neither the DB_DBT_MALLOC or DB_DBT_USERMEM flags were set in the Dbt.

  A record number of 0 was specified.

# Class

Db

# See Also

Db::close, Db::cursor, Db::del, Db::fd, Db::get, Db::get_byteswapped, Db::get_type, Db::join, Db::open, Db::put, Db::stat and Db::sync.`