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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
|
<?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>Dbc::put()</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="dbc.html" title="Chapter 3. The Dbc Handle" />
<link rel="prev" href="dbcget_priority.html" title="Dbc::get_priority()" />
<link rel="next" href="dbcset_priority.html" title="Dbc::set_priority()" />
</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">Dbc::put()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbcget_priority.html">Prev</a> </td>
<th width="60%" align="center">Chapter 3.
The Dbc Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbcset_priority.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="dbcput"></a>Dbc::put()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
Dbc::put(Dbt *key, Dbt *data, u_int32_t flags);</pre>
<p>
The <code class="methodname">Dbc::put()</code> method stores key/data pairs into the database.
</p>
<p>
Unless otherwise specified, the <code class="methodname">Dbc::put()</code> <span>
<span>
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.
</span>
</span>
</p>
<p>
If <code class="methodname">Dbc::put()</code> fails for any reason, the state of the cursor will
be unchanged. If <code class="methodname">Dbc::put()</code> succeeds and an item is inserted
into the database, the cursor is always positioned to refer to the
newly inserted item.
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6310816"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6311008"></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>
<p>
If creating a new record in a Heap database, the
key <a class="link" href="dbt.html" title="Chapter 4. The Dbt Handle">Dbt</a>
must be empty. The <code class="literal">put</code>
method will return the new record's
<a class="link" href="db_heap_rid.html" title="DbHeapRecordId">Record ID (RID)</a>
in the key <a class="link" href="dbt.html" title="Chapter 4. The Dbt Handle">Dbt</a>.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6201832"></a>data</h4>
</div>
</div>
</div>
<p>
The data <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="idp6283912"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set to
one of the following values:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="dbcput_DB_AFTER"></a>
<code class="literal">DB_AFTER</code>
</p>
<p>
In the case of the Btree and Hash access methods, insert the data
element as a duplicate element of the key to which the cursor refers.
The new element appears immediately after the current cursor position.
It is an error to specify DB_AFTER if the underlying Btree or Hash
database is not configured for unsorted duplicate data items. The
<span class="bold"><strong>key</strong></span> parameter is ignored.
</p>
<p>
In the case of the Recno access method, it is an error to specify
DB_AFTER if the underlying Recno database was not created with the
<a class="link" href="dbset_flags.html#dbset_flags_DB_RENUMBER">DB_RENUMBER</a>
flag. If the
<a class="link" href="dbset_flags.html#dbset_flags_DB_RENUMBER">DB_RENUMBER</a>
flag was specified, a new key is created, all records after the inserted
item are automatically renumbered, and the key of the new record is
returned in the structure to which the <span class="bold"><strong>key</strong></span> parameter refers. The initial value of the
<span class="bold"><strong>key</strong></span> parameter is ignored. See
<a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> for more information.
</p>
<p>
The DB_AFTER flag may not be specified to the Queue access method.
</p>
<p>
The <code class="methodname">Dbc::put()</code> method will return
<a href="../../programmer_reference/program_errorret.html#program_errorret.DB_NOTFOUND" class="olink">DB_NOTFOUND</a>
if the current cursor record has already been deleted
and the underlying access method is Hash.
</p>
</li>
<li>
<p><a id="dbcput_DB_BEFORE"></a>
<code class="literal">DB_BEFORE</code>
</p>
<p>
In the case of the Btree and Hash access methods, insert the data
element as a duplicate element of the key to which the cursor refers.
The new element appears immediately before the current cursor
position. It is an error to specify DB_AFTER if the underlying Btree
or Hash database is not configured for unsorted duplicate data items.
The <span class="bold"><strong>key</strong></span> parameter is ignored.
</p>
<p>
In the case of the Recno access method, it is an error to specify
DB_BEFORE if the underlying Recno database was not created with the
<a class="link" href="dbset_flags.html#dbset_flags_DB_RENUMBER">DB_RENUMBER</a>
flag. If the
<a class="link" href="dbset_flags.html#dbset_flags_DB_RENUMBER">DB_RENUMBER</a>
flag was specified, a new key is created, the current record and all
records after it are automatically renumbered, and the key of the new
record is returned in the structure to which the <span class="bold"><strong>key</strong></span> parameter refers. The initial value of the
<span class="bold"><strong>key</strong></span> parameter is ignored. See
<a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> for more information.
</p>
<p>
The DB_BEFORE flag may not be specified to the Queue access method.
</p>
<p>
The <code class="methodname">Dbc::put()</code> method will return
<a href="../../programmer_reference/program_errorret.html#program_errorret.DB_NOTFOUND" class="olink">DB_NOTFOUND</a>
if the current cursor record has already been deleted
and the underlying access method is Hash.
</p>
</li>
<li>
<p><a id="dbcput_DB_CURRENT"></a>
<code class="literal">DB_CURRENT</code>
</p>
<p>
Overwrite the data of the key/data pair to which the cursor refers
with the specified data item. The <span class="bold"><strong>key</strong></span> parameter is ignored.
</p>
<p>
The <code class="methodname">Dbc::put()</code> method will return
<a href="../../programmer_reference/program_errorret.html#program_errorret.DB_NOTFOUND" class="olink">DB_NOTFOUND</a>
if the current cursor record has already been deleted.
</p>
</li>
<li>
<p><a id="dbcput_DB_KEYFIRST"></a>
<code class="literal">DB_KEYFIRST</code>
</p>
<p>
Insert the specified key/data pair into the database.
</p>
<p>
If the underlying database supports duplicate data items, and if the
key already exists in the database and a duplicate sort function has
been specified, the inserted data item is added in its sorted
location. If the key already exists in the database and no duplicate
sort function has been specified, the inserted data item is added as
the first of the data items for that key.
</p>
</li>
<li>
<p><a id="dbcput_DB_KEYLAST"></a>
<code class="literal">DB_KEYLAST</code>
</p>
<p>
Insert the specified key/data pair into the database.
</p>
<p>
If the underlying database supports duplicate data items, and if the
key already exists in the database and a duplicate sort function has
been specified, the inserted data item is added in its sorted
location. If the key already exists in the database, and no duplicate
sort function has been specified, the inserted data item is added as
the last of the data items for that key.
</p>
</li>
<li>
<p><a id="dbcput_DB_NODUPDATA"></a>
<code class="literal">DB_NODUPDATA</code>
</p>
<p>
In the case of the Btree and Hash access methods, insert the specified
key/data pair into the database, unless a key/data pair comparing
equally to it already exists in the database. If a matching key/data
pair already exists in the database,
<a class="xref" href="dbcput.html#dbcput_DB_KEYEXIST" title="DB_KEYEXIST">DB_KEYEXIST</a> is
returned. The DB_NODUPDATA flag may only be specified if the
underlying database has been configured to support sorted duplicate
data items.
</p>
<p>
The DB_NODUPDATA flag may not be specified to the Queue or Recno
access methods.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6321920"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">Dbc::put()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="dbcput_DB_KEYEXIST"></a>DB_KEYEXIST</h4>
</div>
</div>
</div>
<p>
An attempt was made to insert a duplicate key
into a database not configured for duplicate
data.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6337016"></a>DB_FOREIGN_CONFLICT</h4>
</div>
</div>
</div>
<p>
A <a class="link" href="dbassociate_foreign.html" title="Db::associate_foreign()">foreign key constraint violation</a>
has occurred. This can be caused by one of two things:
</p>
<div class="orderedlist">
<ol type="1">
<li>
<p>
An attempt was made to add a record to a
constrained database, and the key used for that
record does not exist in the foreign key
database.
</p>
</li>
<li>
<p>
<a class="link" href="dbassociate_foreign.html#associate_foreign_DB_FOREIGN_ABORT">DB_FOREIGN_ABORT</a>
was declared for a foreign key database, and then
subsequently a record was deleted from the
foreign key database without first removing it
from the constrained secondary database.
</p>
</li>
</ol>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6307424"></a>DB_HEAP_FULL</h4>
</div>
</div>
</div>
<p>
An attempt was made to add or update a record in a Heap
database. However, the size of the database was constrained
using the
<a class="xref" href="dbset_heapsize.html" title="Db::set_heapsize()">Db::set_heapsize()</a>
method, and that limit has been reached.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6342680"></a><span>DbDeadlockException or </span>DB_LOCK_DEADLOCK</h4>
</div>
</div>
</div>
<p>
A transactional database environment operation was selected to resolve
a deadlock.
</p>
<p>
<a class="xref" href="dbdeadlock.html" title="DbDeadlockException">DbDeadlockException</a> is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, <code class="literal">DB_LOCK_DEADLOCK</code> is returned.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6323784"></a><span>DbLockNotGrantedException or </span>DB_LOCK_NOTGRANTED</h4>
</div>
</div>
</div>
<p>
A Berkeley DB Concurrent Data Store database environment configured
for lock timeouts was unable to grant a lock in the allowed time.
</p>
<p>
You attempted to open a database handle that is configured
for no waiting exclusive locking, but the exclusive lock could not be
immediately obtained. See
<a class="xref" href="dbset_lk_exclusive.html" title="Db::set_lk_exclusive()">Db::set_lk_exclusive()</a>
for more information.
</p>
<p>
<a class="xref" href="dblocknotgranted.html" title="DbLockNotGrantedException">DbLockNotGrantedException</a> is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, <code class="literal">DB_LOCK_NOTGRANTED</code> is returned.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6299016"></a> <span>DbRepHandleDeadException or</span> DB_REP_HANDLE_DEAD</h4>
</div>
</div>
</div>
<p>
When a client synchronizes with the master, it is possible for committed
transactions to be rolled back. This invalidates all the database and cursor
handles opened in the replication environment. Once this occurs, an attempt to use
such a handle will
<span>
throw a <a class="xref" href="dbrephandledead.html" title="DbRepHandleDeadException">DbRepHandleDeadException</a> (if
your application is configured to throw exceptions), or
</span>
return <code class="literal">DB_REP_HANDLE_DEAD</code>.
The application will need to discard the handle and open a new one in order to
continue processing.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6346784"></a><span>DbDeadlockException or </span>DB_REP_LOCKOUT</h4>
</div>
</div>
</div>
<p>
The operation was blocked by client/master synchronization.
</p>
<p>
<a class="xref" href="dbdeadlock.html" title="DbDeadlockException">DbDeadlockException</a> is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, <code class="literal">DB_REP_LOCKOUT</code> is returned.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6349160"></a>EACCES</h4>
</div>
</div>
</div>
<p>
An attempt was made to modify a read-only database.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6344696"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If the DB_AFTER, DB_BEFORE or DB_CURRENT flags were specified and the
cursor has not been initialized; the DB_AFTER or DB_BEFORE flags were
specified and a duplicate sort function has been specified; the
DB_CURRENT flag was specified, a duplicate sort function has been
specified, and the data item of the referenced key/data pair does not
compare equally to the <span class="bold"><strong>data</strong></span>
parameter; the DB_AFTER or DB_BEFORE flags were specified, and the
underlying access method is Queue; an attempt was made to add a record
to a fixed-length database that was too large to fit; an attempt was
made to add a record to a secondary index; or if an invalid flag value
or parameter was specified.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6309512"></a>EPERM</h4>
</div>
</div>
</div>
<p>
Write attempted on read-only cursor when the
<a class="link" href="envopen.html#envopen_DB_INIT_CDB">DB_INIT_CDB</a>
flag was specified to <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a>.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6319176"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="dbc.html" title="Chapter 3. The Dbc Handle">Dbc</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6346456"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="dbc.html#dbclist" title="Database Cursors and Related Methods">Database Cursors 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="dbcget_priority.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="dbc.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbcset_priority.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Dbc::get_priority() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Dbc::set_priority()</td>
</tr>
</table>
</div>
</body>
</html>
|
