<!--$Id: db_get.so,v 10.55 2002/08/29 03:24:30 bostic Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB->get</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td>
<h1>DB->get</h1>
</td>
<td align=right>
<a href="../../db4-devel-4.1.25/api_c/c_index.html"><img src="../../db4-4.1.25/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.1.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db.h>
<p>
int
DB->get(DB *db,
DB_TXN *txnid, DBT *key, DBT *data, u_int32_t flags);
int
DB->pget(DB *db,
DB_TXN *txnid, DBT *key, DBT *pkey, DBT *data, u_int32_t flags);
</pre></h3>
<h1>Description</h1>
<p>The DB->get method retrieves key/data pairs from the database. The
address
and length of the data associated with the specified <b>key</b> are
returned in the structure to which <b>data</b> refers.
<p>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.
<b>Retrieval of duplicates requires the use of cursor operations.</b>
See <a href="../../db4-devel-4.1.25/api_c/dbc_get.html">DBcursor->c_get</a> for details.
<p>When called on a database that has been made into a secondary index
using the <a href="../../db4-devel-4.1.25/api_c/db_associate.html">DB->associate</a> method, the DB->get and
DB->pget methods return the key from the secondary index and the data
item from the primary database. In addition, the DB->pget method
returns the key from the primary database. In databases that are not
secondary indices, the DB->pget interface will always fail and
return EINVAL.
<p>If the operation is to be transaction-protected, the <b>txnid</b>
parameter is a transaction handle returned from <a href="../../db4-devel-4.1.25/api_c/txn_begin.html">DB_ENV->txn_begin</a>;
otherwise, NULL.
<p>The <b>flags</b> value must be set to 0 or
one of the following values:
<p><dl compact>
<p><dt><a name="DB_CONSUME">DB_CONSUME</a><dd>Return the record number and data from the available record closest to
the head of the queue, and delete the record. The cursor will be
positioned on the deleted record. The record number will be returned
in <b>key</b>, as described in <a href="../../db4-devel-4.1.25/api_c/dbt_class.html">DBT</a>. The data will be returned
in the <b>data</b> parameter. A record is available if it is not
deleted and is not currently locked. The underlying database must be
of type Queue for DB_CONSUME to be specified.
<p><dt><a name="DB_CONSUME_WAIT">DB_CONSUME_WAIT</a><dd>The DB_CONSUME_WAIT flag is the same as the DB_CONSUME
flag, except that if the Queue database is empty, the thread of control
will wait until there is data in the queue before returning. The
underlying database must be of type Queue for DB_CONSUME_WAIT
to be specified.
<p><dt><a name="DB_GET_BOTH">DB_GET_BOTH</a><dd>Retrieve the key/data pair only if both the key and data match the
arguments.
<p>When used with the DB->pget version of this interface
on a secondary index handle, return the secondary key/primary key/data
tuple only if both the primary and secondary keys match the arguments.
It is an error to use the DB_GET_BOTH flag with the DB->get
version of this interface and a secondary index handle.
<p><dt><a name="DB_SET_RECNO">DB_SET_RECNO</a><dd>Retrieve the specified numbered key/data pair from a database. Upon
return, both the <b>key</b> and <b>data</b> items will have been
filled in.
<p>The <b>data</b> field of the specified <b>key</b>
must be a pointer to a logical record number (that is, a <b>db_recno_t</b>).
This record number determines the record to be retrieved.
<p>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.
</dl>
<p>In addition, the following flags may be set by
bitwise inclusively <b>OR</b>'ing them into the <b>flags</b> parameter:
<p><dl compact>
<p><dt><a name="DB_DIRTY_READ">DB_DIRTY_READ</a><dd>Read modified but not yet committed data. Silently ignored if the
<a href="../../db4-devel-4.1.25/api_c/db_open.html#DB_DIRTY_READ">DB_DIRTY_READ</a> flag was not specified when the underlying
database was opened.
<p><dt><a name="DB_MULTIPLE">DB_MULTIPLE</a><dd>Return multiple data items. The buffer to which the <b>data</b>
argument refers is filled with the specified key's data items. If all
of the data items associated with the key cannot fit into the buffer,
the size field of the <b>data</b> argument is set to the length needed
for the specified items, and the error ENOMEM is returned. The buffer
to which the <b>data</b> argument refers should be large relative to
the page size of the underlying database, aligned for unsigned integer
access, and be a multiple of 1024 bytes in size.
<p>The DB_MULTIPLE flag may only be used alone, or with the
DB_GET_BOTH and DB_SET_RECNO options. The
DB_MULTIPLE flag may not be used when accessing databases made
into secondary indices using the <a href="../../db4-devel-4.1.25/api_c/db_associate.html">DB->associate</a> method.
<p>See <a href="../../db4-devel-4.1.25/api_c/dbt_bulk.html#DB_MULTIPLE_INIT">DB_MULTIPLE_INIT</a> for more information.
<p><dt><a name="DB_RMW">DB_RMW</a><dd>Acquire write locks instead of read locks when doing the retrieval.
Setting this flag can eliminate deadlock during a read-modify-write
cycle by 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.
<p>Because the DB->get interface will not hold locks
across Berkeley DB interface calls in non-transactional environments, the
<a href="../../db4-devel-4.1.25/api_c/dbc_get.html#DB_RMW">DB_RMW</a> flag to the DB->get call is meaningful only in
the presence of transactions.
</dl>
<p>
If the specified key is not in the database, the DB->get method will return DB_NOTFOUND.
If the database is a Queue or Recno database and the specified key
exists, but was never explicitly created by the application or was
later deleted, the DB->get method will return DB_KEYEMPTY.
Otherwise, the DB->get method returns a non-zero error value on failure and 0 on success.
<h1>Errors</h1>
<p>The DB->get method may fail and return a non-zero error for the following conditions:
<p><dl compact>
<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock.
</dl>
<p><dl compact>
<p><dt>DB_SECONDARY_BAD<dd>A secondary index references a nonexistent primary key.
</dl>
<p><dl compact>
<p><dt>ENOMEM<dd>There was insufficient memory to return the requested item.
</dl>
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>A record number of 0 was specified.
<p>The <a href="../../db4-devel-4.1.25/api_c/env_open.html#DB_THREAD">DB_THREAD</a> flag was specified to the <a href="../../db4-devel-4.1.25/api_c/db_open.html">DB->open</a> method and
none of the <a href="../../db4-devel-4.1.25/api_c/dbt_class.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a>, <a href="../../db4-devel-4.1.25/api_c/dbt_class.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> or
<a href="../../db4-devel-4.1.25/api_c/dbt_class.html#DB_DBT_USERMEM">DB_DBT_USERMEM</a> flags were set in the <a href="../../db4-devel-4.1.25/api_c/dbt_class.html">DBT</a>.
<p>The DB->pget interface was called with a <a href="../../db4-devel-4.1.25/api_c/db_class.html">DB</a> handle that
does not refer to a secondary index.
</dl>
<p>The DB->get method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the DB->get method may fail and
return <a href="../../db4-devel-4.1.25/ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>Class</h1>
<a href="../../db4-devel-4.1.25/api_c/db_class.html">DB</a>
<h1>See Also</h1>
<a href="../../db4-devel-4.1.25/api_c/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../../db4-devel-4.1.25/api_c/c_index.html"><img src="../../db4-4.1.25/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.1.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
909f302ad53a08b3685753343102c969
>
files
>
29
