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
|
<! "@(#)put.so 10.11 (Sleepycat) 10/3/98">
<!Copyright 1997, 1998 by Sleepycat Software, Inc. All rights reserved.>
<html>
<body bgcolor=white>
<head>
<title>Berkeley DB: DBcursor->c_put</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btr
ee,hash,hashing,transaction,transactions,locking,logging,access method,access me
thods,java,C,C++">
</head>
<h1>DBcursor->c_put</h1>
<hr size=1 noshade>
<tt>
<h3>
<pre>
#include <db.h>
<p>
int
DBcursor->c_put(DBC *, DBT *key, DBT *data, u_int32_t flags);
</pre>
</h3>
<h1>Description</h1>
<p>
The DBcursor->c_put function stores key/data pairs into the database.
<p>
The <b>flags</b> parameter must be set to one of the following values:
<dl compact>
<a name="DB_AFTER">
<p><dt>DB_AFTER<dd>In the case of the btree and hash access methods,
insert the data element as a duplicate element of the key referenced
by the cursor.
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
was not created with the DB_DUP flag.
The <b>key</b> parameter is ignored.
<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 DB_RENUMBER flag.
If the DB_RENUMBER 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 referenced by the parameter
<b>key</b>.
The initial value of the <b>key</b> parameter is ignored.
See <a href="../../api_c/Db/open.html">db_open</a> for more information.
<p>
If the cursor is not yet initialized or a duplicate sort function has been
specified, the DBcursor->c_put function will return EINVAL.
<a name="DB_BEFORE">
<p><dt>DB_BEFORE<dd>In the case of the btree and hash access methods, insert the data element
as a duplicate element of the key referenced by the cursor.
The new element appears immediately before the current cursor position.
It is an error to specify DB_BEFORE if the underlying btree or hash database
was not created with the DB_DUP flag.
The <b>key</b> parameter is ignored.
<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 DB_RENUMBER flag.
If the DB_RENUMBER 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 referenced by
the parameter <b>key</b>.
The initial value of the <b>key</b> parameter is ignored.
See <a href="../../api_c/Db/open.html">db_open</a> for more information.
<p>
If the cursor is not yet initialized or a duplicate sort function has been
specified, DBcursor->c_put will return EINVAL.
<a name="DB_CURRENT">
<p><dt>DB_CURRENT<dd>Overwrite the data of the key/data pair referenced by the cursor with the
specified data item.
<p>
The <b>key</b> parameter is ignored.
<p>
If a duplicate sort function has been specified and the data item of the
current referenced key/data pair does not compare equally to the <b>data</b>
parameter, DBcursor->c_put will return EINVAL.
<p>
If the cursor is not yet initialized,
DBcursor->c_put will return EINVAL.
<a name="DB_KEYFIRST">
<p><dt>DB_KEYFIRST<dd>In the case of the btree and hash access methods, insert the specified
key/data pair into the database.
<p>
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>
The DB_KEYFIRST flag may not be specified to the recno access method.
<a name="DB_KEYLAST">
<p><dt>DB_KEYLAST<dd>Insert the specified key/data pair into the database.
<p>
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>
The DB_KEYLAST flag may not be specified to the recno access method.
</dl>
<p>
If the cursor record has been deleted,
DBcursor->c_put will return DB_KEYEMPTY.
<p>
Otherwise, the DBcursor->c_put
function returns the value of <b>errno</b> on failure, and 0 on success.
<p>
If DBcursor->c_put fails for any reason, the state of the cursor
will be unchanged.
If DBcursor->c_put succeeds and an item is inserted into the
database, the cursor is always positioned to reference the newly
inserted item.
<p>
<h1>Errors</h1>
If a fatal error occurs in Berkeley DB, the DBcursor->c_put function may fail and return
DB_RUNRECOVERY, at which point all subsequent database calls will also
return DB_RUNRECOVERY.
<p>
The DBcursor->c_put
function may fail and return <b>errno</b>
for any of the errors specified for the following Berkeley DB and C library
functions:
__account_page(3),
abort(3),
dbenv->db_paniccall(3),
dbp->dup_compare(3),
fflush(3),
fprintf(3),
free(3),
func(3),
hcp->dbc->dbp->h_hash(3),
<a href="../../api_c/DbLockTab/get.html">lock_get</a>,
<a href="../../api_c/DbLock/put.html">lock_put</a>,
<a href="../../api_c/DbLockTab/vec.html">lock_vec</a>,
<a href="../../api_c/DbLog/put.html">log_put</a>,
malloc(3),
memcmp(3),
memcpy(3),
memmove(3),
<a href="../../api_c/DbMpoolFile/get.html">memp_fget</a>,
<a href="../../api_c/DbMpoolFile/put.html">memp_fput</a>,
<a href="../../api_c/DbMpoolFile/set.html">memp_fset</a>,
memset(3),
realloc(3),
strerror(3),
vfprintf(3),
and
vsnprintf(3).
<p>
In addition, the DBcursor->c_put
function may fail and return <b>errno</b>
for the following conditions:
<p>
<dl compact>
<p><dt>EACCES<dd>An attempt was made to modify a read-only database.
</dl>
<p>
<dl compact>
<p><dt>EAGAIN<dd>A lock was unavailable.
</dl>
<p>
<dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>
</dl>
<p>
<h1>See Also</h1>
<a href="../../api_c/DbEnv/appexit.html">db_appexit</a>,
<a href="../../api_c/DbEnv/appinit.html">db_appinit</a>,
<a href="../../api_c/DbEnv/version.html">db_version</a>,
<a href="../../api_c/Db/close.html">DB->close</a>,
<a href="../../api_c/Db/cursor.html">DB->cursor</a>,
<a href="../../api_c/Db/del.html">DB->del</a>,
<a href="../../api_c/Db/fd.html">DB->fd</a>,
<a href="../../api_c/Db/get.html">DB->get</a>,
<a href="../../api_c/Db/open.html">db_open</a>,
<a href="../../api_c/Db/put.html">DB->put</a>,
<a href="../../api_c/Db/stat.html">DB->stat</a>,
<a href="../../api_c/Db/sync.html">DB->sync</a>,
<a href="../../api_c/Dbc/close.html">DBcursor->c_close</a>,
<a href="../../api_c/Dbc/del.html">DBcursor->c_del</a>,
<a href="../../api_c/Dbc/get.html">DBcursor->c_get</a>
and
DBcursor->c_put.
</tt>
</body>
</html>
|
