libdb/docs/api_reference/TCL/db_del.html
2011-09-13 13:44:24 -04:00

109 lines
4.4 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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 del</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="tclapi.html" title="Chapter 1.  Berkeley DB Tcl APIs" />
<link rel="prev" href="db_cursor.html" title="db cursor" />
<link rel="next" href="db_get.html" title="db get" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center"><span xmlns="http://www.w3.org/1999/xhtml" class="emphasis"><em>db</em></span> del</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="db_cursor.html">Prev</a> </td>
<th width="60%" align="center">Chapter 1. 
Berkeley DB Tcl APIs
</th>
<td width="20%" align="right"> <a accesskey="n" href="db_get.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="db_del"></a><span class="emphasis"><em>db</em></span> del</h2>
</div>
</div>
</div>
<pre class="programlisting">db del
[-glob]
[-txn txnid]
key </pre>
<p>
The <span class="emphasis"><em>db</em></span> <span class="bold"><strong>del</strong></span>
command removes key/data pairs from the database.
</p>
<p>
In the presence of duplicate key values, all records associated with
the designated key will be discarded.
</p>
<p>
The options are as follows:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<span class="bold"><strong>-glob</strong></span>
</p>
<p>
The specified key is a wildcard pattern, and all keys matching that
pattern are discarded from the database. The pattern is a simple
wildcard, any characters after the wildcard character are ignored.
This option only works on databases using the Btree access method.
</p>
</li>
<li>
<p>
<span class="bold"><strong>-txn txnid</strong></span>
</p>
<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 <span class="emphasis"><em>env</em></span> <span class="bold"><strong>txn</strong></span>. If no transaction handle is specified,
but the operation occurs in a transactional database, the operation
will be implicitly transaction protected.
</p>
</li>
</ul>
</div>
<p>
The <span class="emphasis"><em>db</em></span> <span class="bold"><strong>del</strong></span>
command returns 0 on success, and in the case of error, a Tcl error is
thrown.
</p>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="db_cursor.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="tclapi.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="db_get.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top"><span class="emphasis"><em>db</em></span> cursor </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> get</td>
</tr>
</table>
</div>
</body>
</html>