File: dbexists.html

package info (click to toggle)
db5.3 5.3.28%2Bdfsg1-0.5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 158,360 kB
  • sloc: ansic: 448,411; java: 111,824; tcl: 80,544; sh: 44,326; cs: 33,697; cpp: 21,604; perl: 14,557; xml: 10,799; makefile: 4,077; yacc: 1,003; awk: 965; sql: 801; erlang: 342; python: 216; php: 24; asm: 14
file content (198 lines) | stat: -rw-r--r-- 8,534 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>Db::exists()</title>
    <link rel="stylesheet" href="apiReference.css" type="text/css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
    <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
    <link rel="up" href="db.html" title="Chapter 2.  The Db Handle" />
    <link rel="prev" href="dberr.html" title="Db::err()" />
    <link rel="next" href="dbfd.html" title="Db::fd()" />
  </head>
  <body>
    <div xmlns="" class="navheader">
      <div class="libver">
        <p>Library Version 11.2.5.3</p>
      </div>
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">Db::exists()</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="dberr.html">Prev</a> </td>
          <th width="60%" align="center">Chapter 2. 
                The Db Handle
        </th>
          <td width="20%" align="right"> <a accesskey="n" href="dbfd.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="sect1" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title" style="clear: both"><a id="dbexists"></a>Db::exists()</h2>
          </div>
        </div>
      </div>
      <pre class="programlisting">#include &lt;db_cxx.h&gt;
 
int
Db::exists(DbTxn *txnid, Dbt *key, u_int32_t flags);</pre>
      <p>
         The <code class="methodname">Db::exists()</code> method returns whether the specified key appears in the
         database.
    </p>
      <p>
         The <code class="methodname">Db::exists()</code> method will return <a href="../../programmer_reference/program_errorret.html#program_errorret.DB_NOTFOUND" class="olink">DB_NOTFOUND</a> if the specified key
         is not in the database. The <code class="methodname">Db::exists()</code> method will return
         <a href="../../programmer_reference/program_errorret.html#program_errorret.DB_KEYEMPTY" class="olink">DB_KEYEMPTY</a> 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. 
    </p>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idm914008"></a>Parameters</h3>
            </div>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp2890768"></a>txnid</h4>
              </div>
            </div>
          </div>
          <p>
                If the operation is part of an application-specified transaction, the <span class="bold"><strong>txnid</strong></span> parameter is a transaction handle returned from
                <a class="xref" href="txnbegin.html" title="DbEnv::txn_begin()">DbEnv::txn_begin()</a>; if the operation is part of a
                Berkeley DB Concurrent Data Store group, the <span class="bold"><strong>txnid</strong></span>
                parameter is a handle returned from 
                <a class="xref" href="envcdsgroup_begin.html" title="DbEnv::cdsgroup_begin()">DbEnv::cdsgroup_begin()</a>; otherwise NULL.  
                If no transaction handle is specified, but the
                operation occurs in a transactional database, the operation will be
                implicitly transaction protected.
            </p>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp4528688"></a>key</h4>
              </div>
            </div>
          </div>
          <p>
                The key <a class="link" href="dbt.html" title="Chapter 4.  The Dbt Handle">Dbt</a>  operated on.
            </p>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp2622904"></a>flags</h4>
              </div>
            </div>
          </div>
          <p>
                The <span class="bold"><strong>flags</strong></span> parameter must be set to zero or
                by bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing together one
                or more of the following values:
            </p>
          <div class="itemizedlist">
            <ul type="disc">
              <li>
                <p><a id="exists_DB_READ_COMMITTED"></a>
                    <code class="literal">DB_READ_COMMITTED</code>
                </p>
                <p>
                    Configure a transactional read operation to have degree 2 isolation
                    (the read is not repeatable).
                </p>
              </li>
              <li>
                <p><a id="exists_DB_READ_UNCOMMITTED"></a>
                    <code class="literal">DB_READ_UNCOMMITTED</code>
                </p>
                <p>
                    Configure a transactional read operation to have degree 1 isolation,
                    reading modified but not yet committed data.  Silently ignored if the
                    <a class="link" href="dbopen.html#dbopen_DB_READ_UNCOMMITTED">DB_READ_UNCOMMITTED</a> 
                    flag was not specified when the underlying database was opened.
                </p>
              </li>
              <li>
                <p><a id="exists_DB_RMW"></a>
                    <code class="literal">DB_RMW</code>
                </p>
                <p>
                    Acquire write locks instead of read locks when doing the read, if locking is
                    configured.  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>
                <p>
                    Because the <code class="methodname">Db::exists()</code> method will not hold locks
                    across Berkeley DB calls in non-transactional operations, the 
                    <a class="link" href="dbcget.html#dbcget_DB_RMW">DB_RMW</a>  flag to the
                    <code class="methodname">Db::exists()</code> call is meaningful only in the presence
                    of transactions.
                </p>
              </li>
            </ul>
          </div>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp950616"></a>Class</h3>
            </div>
          </div>
        </div>
        <p>
            <a class="link" href="db.html" title="Chapter 2.  The Db Handle">Db</a>  
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp941448"></a>See Also</h3>
            </div>
          </div>
        </div>
        <p>
            <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a> 
        </p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="dberr.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="db.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="dbfd.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">Db::err() </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> Db::fd()</td>
        </tr>
      </table>
    </div>
  </body>
</html>