← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_cxx/db_get.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdb/docs/api_cxx/db_get.html
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: Db::get</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>Db::get</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
#include &lt;db_cxx.h&gt;
24
 
<p>
25
 
int
26
 
Db::get(DbTxn *txnid, Dbt *key, Dbt *data, u_int32_t flags);
27
 
int
28
 
Db::pget(DbTxn *txnid, Dbt *key, Dbt *pkey, Dbt *data, u_int32_t flags);
29
 
</pre></h3>
30
 
<h1>Description</h1>
31
 
<p>The Db::get method retrieves key/data pairs from the database.  The
32
 
address
33
 
and length of the data associated with the specified <b>key</b> are
34
 
returned in the structure to which <b>data</b> refers.
35
 
<p>In the presence of duplicate key values, Db::get will return the
36
 
first data item for the designated key.  Duplicates are sorted by insert
37
 
order, except where this order has been overridden by cursor operations.
38
 
<b>Retrieval of duplicates requires the use of cursor operations.</b>
39
 
See <a href="../api_cxx/dbc_get.html">Dbc::get</a> for details.
40
 
<p>When called on a database that has been made into a secondary index
41
 
using the <a href="../api_cxx/db_associate.html">Db::associate</a> method, the Db::get and
42
 
Db::pget methods return the key from the secondary index and the data
43
 
item from the primary database.  In addition, the Db::pget method
44
 
returns the key from the primary database.  In databases that are not
45
 
secondary indices, the Db::pget interface will always fail and
46
 
return EINVAL.
47
 
<p>If the operation is to be transaction-protected, the <b>txnid</b>
48
 
parameter is a transaction handle returned from <a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>;
49
 
otherwise, NULL.
50
 
<p>The <b>flags</b> value must be set to 0 or
51
 
one of the following values:
52
 
<p><dl compact>
53
 
<p><dt><a name="DB_CONSUME">DB_CONSUME</a><dd>Return the record number and data from the available record closest to
54
 
the head of the queue, and delete the record.  The cursor will be
55
 
positioned on the deleted record.  The record number will be returned
56
 
in <b>key</b>, as described in <a href="../api_cxx/dbt_class.html">Dbt</a>.  The data will be returned
57
 
in the <b>data</b> parameter.  A record is available if it is not
58
 
deleted and is not currently locked.  The underlying database must be
59
 
of type Queue for DB_CONSUME to be specified.
60
 
<p><dt><a name="DB_CONSUME_WAIT">DB_CONSUME_WAIT</a><dd>The DB_CONSUME_WAIT flag is the same as the DB_CONSUME
61
 
flag, except that if the Queue database is empty, the thread of control
62
 
will wait until there is data in the queue before returning.  The
63
 
underlying database must be of type Queue for DB_CONSUME_WAIT
64
 
to be specified.
65
 
<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
66
 
arguments.
67
 
<p>When used with the Db::pget version of this interface
68
 
on a secondary index handle, return the secondary key/primary key/data
69
 
tuple only if both the primary and secondary keys match the arguments.
70
 
It is an error to use the DB_GET_BOTH flag with the Db::get
71
 
version of this interface and a secondary index handle.
72
 
<p><dt><a name="DB_SET_RECNO">DB_SET_RECNO</a><dd>Retrieve the specified numbered key/data pair from a database.  Upon
73
 
return, both the <b>key</b> and <b>data</b> items will have been
74
 
filled in.
75
 
<p>The <b>data</b> field of the specified <b>key</b>
76
 
must be a pointer to a logical record number (that is, a <b>db_recno_t</b>).
77
 
This record number determines the record to be retrieved.
78
 
<p>For DB_SET_RECNO to be specified, the underlying database must be
79
 
of type Btree, and it must have been created with the DB_RECNUM flag.
80
 
</dl>
81
 
<p>In addition, the following flags may be set by
82
 
bitwise inclusively <b>OR</b>'ing them into the <b>flags</b> parameter:
83
 
<p><dl compact>
84
 
<p><dt><a name="DB_DIRTY_READ">DB_DIRTY_READ</a><dd>Read modified but not yet committed data.  Silently ignored if the
85
 
<a href="../api_cxx/db_open.html#DB_DIRTY_READ">DB_DIRTY_READ</a> flag was not specified when the underlying
86
 
database was opened.
87
 
<p><dt><a name="DB_MULTIPLE">DB_MULTIPLE</a><dd>Return multiple data items.  The buffer to which the <b>data</b>
88
 
argument refers is filled with the specified key's data items.  If all
89
 
of the data items associated with the key cannot fit into the buffer,
90
 
the size field of the <b>data</b> argument is set to the length needed
91
 
for the specified items, and the error ENOMEM is returned.  The buffer
92
 
to which the <b>data</b> argument refers should be large relative to
93
 
the page size of the underlying database, aligned for unsigned integer
94
 
access, and be a multiple of 1024 bytes in size.
95
 
<p>The DB_MULTIPLE flag may only be used alone, or with the
96
 
DB_GET_BOTH and DB_SET_RECNO options.  The
97
 
DB_MULTIPLE flag may not be used when accessing databases made
98
 
into secondary indices using the <a href="../api_cxx/db_associate.html">Db::associate</a> method.
99
 
<p>See <a href="../api_cxx/dbt_bulk.html#DB_MULTIPLE_INIT">DB_MULTIPLE_INIT</a> for more information.
100
 
<p><dt><a name="DB_RMW">DB_RMW</a><dd>Acquire write locks instead of read locks when doing the retrieval.
101
 
Setting this flag can eliminate deadlock during a read-modify-write
102
 
cycle by acquiring the write lock during the read part of the cycle so
103
 
that another thread of control acquiring a read lock for the same item,
104
 
in its own read-modify-write cycle, will not result in deadlock.
105
 
<p>Because the Db::get interface will not hold locks
106
 
across Berkeley DB interface calls in non-transactional environments, the
107
 
<a href="../api_cxx/dbc_get.html#DB_RMW">DB_RMW</a> flag to the Db::get call is meaningful only in
108
 
the presence of transactions.
109
 
</dl>
110
 
<p>
111
 
If the specified key is not in the database, the Db::get method will return DB_NOTFOUND.
112
 
If the database is a Queue or Recno database and the specified key
113
 
exists, but was never explicitly created by the application or was
114
 
later deleted, the Db::get method will return DB_KEYEMPTY.
115
 
Otherwise, the Db::get method either returns a non-zero error value or throws an exception that
116
 
encapsulates a non-zero error value on failure, and returns 0 on success.
117
 
<h1>Errors</h1>
118
 
<p>The Db::get method may fail and throw an exception or return a non-zero error for the following conditions:
119
 
<p><dl compact>
120
 
<p><dt>DB_SECONDARY_BAD<dd>A secondary index references a nonexistent primary key.
121
 
</dl>
122
 
<p><dl compact>
123
 
<p><dt>ENOMEM<dd>There was insufficient memory to return the requested item.
124
 
</dl>
125
 
<p><dl compact>
126
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
127
 
<p>A record number of 0 was specified.
128
 
<p>The <a href="../api_cxx/env_open.html#DB_THREAD">DB_THREAD</a> flag was specified to the <a href="../api_cxx/db_open.html">Db::open</a> method and
129
 
none of the <a href="../api_cxx/dbt_class.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a>, <a href="../api_cxx/dbt_class.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> or
130
 
<a href="../api_cxx/dbt_class.html#DB_DBT_USERMEM">DB_DBT_USERMEM</a> flags were set in the <a href="../api_cxx/dbt_class.html">Dbt</a>.
131
 
<p>The Db::pget interface was called with a <a href="../api_cxx/db_class.html">Db</a> handle that
132
 
does not refer to a secondary index.
133
 
</dl>
134
 
<p>If the operation was selected to resolve a deadlock, the
135
 
Db::get method will fail and
136
 
and either return <a href="../ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a> or
137
 
throw a <a href="../api_cxx/deadlock_class.html">DbDeadlockException</a> exception.
138
 
<p>If the requested item could not be returned due to insufficient memory,
139
 
the Db::get method will fail and
140
 
either return ENOMEM or
141
 
throw a <a href="../api_cxx/memp_class.html">DbMemoryException</a> exception.
142
 
<p>The Db::get 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.
143
 
If a catastrophic error has occurred, the Db::get method may fail and
144
 
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
145
 
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
146
 
in which case all subsequent Berkeley DB calls will fail in the same way.
147
 
<h1>Class</h1>
148
 
<a href="../api_cxx/db_class.html">Db</a>
149
 
<h1>See Also</h1>
150
 
<a href="../api_cxx/db_list.html">Databases and Related Methods</a>
151
 
</tt>
152
 
<table width="100%"><tr><td><br></td><td align=right>
153
 
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
154
 
</td></tr></table>
155
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
156
 
</body>
157
 
</html>