File: tclapi.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 (301 lines) | stat: -rw-r--r-- 11,957 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
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
<?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>Chapter 1.  Berkeley DB Tcl APIs</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 TCL API Reference" />
    <link rel="up" href="index.html" title="Berkeley DB TCL API Reference" />
    <link rel="prev" href="preface.html" title="Preface" />
    <link rel="next" href="db_close.html" title="db close" />
  </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">Chapter 1. 
                Berkeley DB Tcl APIs
        </th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="preface.html">Prev</a> </td>
          <th width="60%" align="center"> </th>
          <td width="20%" align="right"> <a accesskey="n" href="db_close.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="chapter" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title"><a id="tclapi"></a>Chapter 1. 
                Berkeley DB Tcl APIs
        </h2>
          </div>
        </div>
      </div>
      <p>
                This book documents the Tcl APIs that are available for
                working with Berkeley DB databases. This book assumes you
                have some familiarity with Berkeley DB.
        </p>
      <div class="sect1" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h2 class="title" style="clear: both"><a id="tcllist"></a>Tcl Methods</h2>
            </div>
          </div>
        </div>
        <div class="navtable">
          <table border="1" width="80%">
            <thead>
              <tr>
                <th>Database Methods</th>
                <th>Description</th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td>
                  <a class="xref" href="db_close.html" title="db close"><span class="emphasis"><em>db</em></span> close</a>
                </td>
                <td>Close a database</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_count.html" title="db count"><span class="emphasis"><em>db</em></span> count</a>
                </td>
                <td>Return a count of the key's data items</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_del.html" title="db del"><span class="emphasis"><em>db</em></span> del</a>
                </td>
                <td>Delete items from the database</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_get.html" title="db get"><span class="emphasis"><em>db</em></span> get</a>
                </td>
                <td>Get items from a database</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_get_join.html" title="db get_join"><span class="emphasis"><em>db</em></span> get_join</a>
                </td>
                <td>Get items from a database join</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_get_type.html" title="db get_type"><span class="emphasis"><em>db</em></span> get_type</a>
                </td>
                <td>Return the database type</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_is_byteswapped.html" title="db is_byteswapped"><span class="emphasis"><em>db</em></span> is_byteswapped</a>
                </td>
                <td>Return if the underlying database is in host order</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_open.html" title="berkdb open">berkdb open</a>
                </td>
                <td>Create and open a database handle</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_put.html" title="db put"><span class="emphasis"><em>db</em></span> put</a>
                </td>
                <td>Store items into a database</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_remove.html" title="berkdb dbremove">berkdb dbremove</a>
                </td>
                <td>Remove a database</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_rename.html" title="berkdb dbrename">berkdb dbrename</a>
                </td>
                <td>Rename a database</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_stat.html" title="db stat"><span class="emphasis"><em>db</em></span> stat</a>
                </td>
                <td>Return database statistics</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_sync.html" title="db sync"><span class="emphasis"><em>db</em></span> sync</a>
                </td>
                <td>Flush a database to stable storage</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_truncate.html" title="db truncate"><span class="emphasis"><em>db</em></span> truncate</a>
                </td>
                <td>Truncate a database</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="version.html" title="berkdb version">berkdb version</a>
                </td>
                <td>Return version information</td>
              </tr>
              <tr>
                <td colspan="2">
                  <span class="bold">
                    <strong>Cursor Methods</strong>
                  </span>
                </td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_cursor.html" title="db cursor"><span class="emphasis"><em>db</em></span> cursor</a>
                </td>
                <td>Open a cursor in the database</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="db_join.html" title="db join"><span class="emphasis"><em>db</em></span> join</a>
                </td>
                <td>Perform a database join on cursors</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="dbc_close.html" title="dbc close"><span class="emphasis"><em>dbc</em></span> close</a>
                </td>
                <td>Close a cursor</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="dbc_cmp.html" title="dbc cmp"><span class="emphasis"><em>dbc</em></span> cmp</a>
                </td>
                <td>Compare two cursors</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="dbc_del.html" title="dbc del"><span class="emphasis"><em>dbc</em></span> del</a>
                </td>
                <td>Delete by cursor</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="dbc_dup.html" title="dbc dup"><span class="emphasis"><em>dbc</em></span> dup</a>
                </td>
                <td>Duplicate a cursor</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="dbc_get.html" title="dbc get"><span class="emphasis"><em>dbc</em></span> get</a>
                </td>
                <td>Retrieve by cursor</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="dbc_put.html" title="dbc put"><span class="emphasis"><em>dbc</em></span> put</a>
                </td>
                <td>Store by cursor</td>
              </tr>
              <tr>
                <td colspan="2">
                  <span class="bold">
                    <strong>Environment Methods</strong>
                  </span>
                </td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="env_close.html" title="env close"><span class="emphasis"><em>env</em></span> close</a>
                </td>
                <td>Close an environment</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="env_dbremove.html" title="env dbremove"><span class="emphasis"><em>env</em></span> dbremove</a>
                </td>
                <td>Remove an environment</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="env_dbrename.html" title="env dbrename"><span class="emphasis"><em>env</em></span> dbrename</a>
                </td>
                <td>Rename a database</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="env_open.html" title="berkdb env">berkdb env</a>
                </td>
                <td>Create and open an environment handle</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="env_remove.html" title="berkdb envremove">berkdb envremove</a>
                </td>
                <td>Remove an environment handle</td>
              </tr>
              <tr>
                <td colspan="2">
                  <span class="bold">
                    <strong>Transaction Methods</strong>
                  </span>
                </td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="txn.html" title="env txn"><span class="emphasis"><em>env</em></span> txn</a>
                </td>
                <td>Begin a transaction</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="txn_abort.html" title="txn abort"><span class="emphasis"><em>txn</em></span> abort</a>
                </td>
                <td>Abort a transaction</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="txn_checkpoint.html" title="env txn_checkpoint"><span class="emphasis"><em>env</em></span> txn_checkpoint</a>
                </td>
                <td>Checkpoint the environment</td>
              </tr>
              <tr>
                <td>
                  <a class="xref" href="txn_commit.html" title="txn commit"><span class="emphasis"><em>txn</em></span> commit</a>
                </td>
                <td>Commit a transaction</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="preface.html">Prev</a> </td>
          <td width="20%" align="center"> </td>
          <td width="40%" align="right"> <a accesskey="n" href="db_close.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">Preface </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> <span class="emphasis"><em>db</em></span> close</td>
        </tr>
      </table>
    </div>
  </body>
</html>