1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>Chapter��1.�� Berkeley DB Tcl APIs</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB TCL API Reference" /> 10 <link rel="up" href="index.html" title="Berkeley DB TCL API Reference" /> 11 <link rel="prev" href="preface.html" title="Preface" /> 12 <link rel="next" href="db_close.html" title="db close" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">Chapter��1.�� 19 Berkeley DB Tcl APIs 20 </th> 21 </tr> 22 <tr> 23 <td width="20%" align="left"><a accesskey="p" href="preface.html">Prev</a>��</td> 24 <th width="60%" align="center">��</th> 25 <td width="20%" align="right">��<a accesskey="n" href="db_close.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="chapter" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title"><a id="tclapi"></a>Chapter��1.�� 35 Berkeley DB Tcl APIs 36 </h2> 37 </div> 38 </div> 39 </div> 40 <p> 41 This book documents the Tcl APIs that are available for 42 working with Berkeley DB databases. This book assumes you 43 have some familiarity with Berkeley DB. 44 </p> 45 <div class="sect1" lang="en" xml:lang="en"> 46 <div class="titlepage"> 47 <div> 48 <div> 49 <h2 class="title" style="clear: both"><a id="tcllist"></a>Tcl Methods</h2> 50 </div> 51 </div> 52 </div> 53 <div class="navtable"> 54 <table border="1" width="80%"> 55 <thead> 56 <tr> 57 <th>Database Methods</th> 58 <th>Description</th> 59 </tr> 60 </thead> 61 <tbody> 62 <tr> 63 <td> 64 <a class="xref" href="db_close.html" title="db close"><span class="emphasis"><em>db</em></span> close</a> 65 </td> 66 <td>Close a database</td> 67 </tr> 68 <tr> 69 <td> 70 <a class="xref" href="db_count.html" title="db count"><span class="emphasis"><em>db</em></span> count</a> 71 </td> 72 <td>Return a count of the key's data items</td> 73 </tr> 74 <tr> 75 <td> 76 <a class="xref" href="db_del.html" title="db del"><span class="emphasis"><em>db</em></span> del</a> 77 </td> 78 <td>Delete items from the database</td> 79 </tr> 80 <tr> 81 <td> 82 <a class="xref" href="db_get.html" title="db get"><span class="emphasis"><em>db</em></span> get</a> 83 </td> 84 <td>Get items from a database</td> 85 </tr> 86 <tr> 87 <td> 88 <a class="xref" href="db_get_join.html" title="db get_join"><span class="emphasis"><em>db</em></span> get_join</a> 89 </td> 90 <td>Get items from a database join</td> 91 </tr> 92 <tr> 93 <td> 94 <a class="xref" href="db_get_type.html" title="db get_type"><span class="emphasis"><em>db</em></span> get_type</a> 95 </td> 96 <td>Return the database type</td> 97 </tr> 98 <tr> 99 <td> 100 <a class="xref" href="db_is_byteswapped.html" title="db is_byteswapped"><span class="emphasis"><em>db</em></span> is_byteswapped</a> 101 </td> 102 <td>Return if the underlying database is in host order</td> 103 </tr> 104 <tr> 105 <td> 106 <a class="xref" href="db_open.html" title="berkdb open">berkdb open</a> 107 </td> 108 <td>Create and open a database handle</td> 109 </tr> 110 <tr> 111 <td> 112 <a class="xref" href="db_put.html" title="db put"><span class="emphasis"><em>db</em></span> put</a> 113 </td> 114 <td>Store items into a database</td> 115 </tr> 116 <tr> 117 <td> 118 <a class="xref" href="db_remove.html" title="berkdb dbremove">berkdb dbremove</a> 119 </td> 120 <td>Remove a database</td> 121 </tr> 122 <tr> 123 <td> 124 <a class="xref" href="db_rename.html" title="berkdb dbrename">berkdb dbrename</a> 125 </td> 126 <td>Rename a database</td> 127 </tr> 128 <tr> 129 <td> 130 <a class="xref" href="db_stat.html" title="db stat"><span class="emphasis"><em>db</em></span> stat</a> 131 </td> 132 <td>Return database statistics</td> 133 </tr> 134 <tr> 135 <td> 136 <a class="xref" href="db_sync.html" title="db sync"><span class="emphasis"><em>db</em></span> sync</a> 137 </td> 138 <td>Flush a database to stable storage</td> 139 </tr> 140 <tr> 141 <td> 142 <a class="xref" href="db_truncate.html" title="db truncate"><span class="emphasis"><em>db</em></span> truncate</a> 143 </td> 144 <td>Truncate a database</td> 145 </tr> 146 <tr> 147 <td> 148 <a class="xref" href="version.html" title="berkdb version">berkdb version</a> 149 </td> 150 <td>Return version information</td> 151 </tr> 152 <tr> 153 <td colspan="2"> 154 <span class="bold"> 155 <strong>Cursor Methods</strong> 156 </span> 157 </td> 158 </tr> 159 <tr> 160 <td> 161 <a class="xref" href="db_cursor.html" title="db cursor"><span class="emphasis"><em>db</em></span> cursor</a> 162 </td> 163 <td>Open a cursor in the database</td> 164 </tr> 165 <tr> 166 <td> 167 <a class="xref" href="db_join.html" title="db join"><span class="emphasis"><em>db</em></span> join</a> 168 </td> 169 <td>Perform a database join on cursors</td> 170 </tr> 171 <tr> 172 <td> 173 <a class="xref" href="dbc_close.html" title="dbc close"><span class="emphasis"><em>dbc</em></span> close</a> 174 </td> 175 <td>Close a cursor</td> 176 </tr> 177 <tr> 178 <td> 179 <a class="xref" href="dbc_del.html" title="dbc del"><span class="emphasis"><em>dbc</em></span> del</a> 180 </td> 181 <td>Delete by cursor</td> 182 </tr> 183 <tr> 184 <td> 185 <a class="xref" href="dbc_dup.html" title="dbc dup"><span class="emphasis"><em>dbc</em></span> dup</a> 186 </td> 187 <td>Duplicate a cursor</td> 188 </tr> 189 <tr> 190 <td> 191 <a class="xref" href="dbc_get.html" title="dbc get"><span class="emphasis"><em>dbc</em></span> get</a> 192 </td> 193 <td>Retrieve by cursor</td> 194 </tr> 195 <tr> 196 <td> 197 <a class="xref" href="dbc_put.html" title="dbc put"><span class="emphasis"><em>dbc</em></span> put</a> 198 </td> 199 <td>Store by cursor</td> 200 </tr> 201 <tr> 202 <td colspan="2"> 203 <span class="bold"> 204 <strong>Environment Methods</strong> 205 </span> 206 </td> 207 </tr> 208 <tr> 209 <td> 210 <a class="xref" href="env_close.html" title="env close"><span class="emphasis"><em>env</em></span> close</a> 211 </td> 212 <td>Close an environment</td> 213 </tr> 214 <tr> 215 <td> 216 <a class="xref" href="env_dbremove.html" title="env dbremove"><span class="emphasis"><em>env</em></span> dbremove</a> 217 </td> 218 <td>Remove an environment</td> 219 </tr> 220 <tr> 221 <td> 222 <a class="xref" href="env_dbrename.html" title="env dbrename"><span class="emphasis"><em>env</em></span> dbrename</a> 223 </td> 224 <td>Rename a database</td> 225 </tr> 226 <tr> 227 <td> 228 <a class="xref" href="env_open.html" title="berkdb env">berkdb env</a> 229 </td> 230 <td>Create and open an environment handle</td> 231 </tr> 232 <tr> 233 <td> 234 <a class="xref" href="env_remove.html" title="berkdb envremove">berkdb envremove</a> 235 </td> 236 <td>Remove an environment handle</td> 237 </tr> 238 <tr> 239 <td colspan="2"> 240 <span class="bold"> 241 <strong>Transaction Methods</strong> 242 </span> 243 </td> 244 </tr> 245 <tr> 246 <td> 247 <a class="xref" href="txn.html" title="env txn"><span class="emphasis"><em>env</em></span> txn</a> 248 </td> 249 <td>Begin a transaction</td> 250 </tr> 251 <tr> 252 <td> 253 <a class="xref" href="txn_abort.html" title="txn abort"><span class="emphasis"><em>txn</em></span> abort</a> 254 </td> 255 <td>Abort a transaction</td> 256 </tr> 257 <tr> 258 <td> 259 <a class="xref" href="txn_checkpoint.html" title="env txn_checkpoint"><span class="emphasis"><em>env</em></span> txn_checkpoint</a> 260 </td> 261 <td>Checkpoint the environment</td> 262 </tr> 263 <tr> 264 <td> 265 <a class="xref" href="txn_commit.html" title="txn commit"><span class="emphasis"><em>txn</em></span> commit</a> 266 </td> 267 <td>Commit a transaction</td> 268 </tr> 269 </tbody> 270 </table> 271 </div> 272 </div> 273 </div> 274 <div class="navfooter"> 275 <hr /> 276 <table width="100%" summary="Navigation footer"> 277 <tr> 278 <td width="40%" align="left"><a accesskey="p" href="preface.html">Prev</a>��</td> 279 <td width="20%" align="center">��</td> 280 <td width="40%" align="right">��<a accesskey="n" href="db_close.html">Next</a></td> 281 </tr> 282 <tr> 283 <td width="40%" align="left" valign="top">Preface��</td> 284 <td width="20%" align="center"> 285 <a accesskey="h" href="index.html">Home</a> 286 </td> 287 <td width="40%" align="right" valign="top">��<span class="emphasis"><em>db</em></span> close</td> 288 </tr> 289 </table> 290 </div> 291 </body> 292</html> 293