<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--Converted with LaTeX2HTML 98.2 beta6 (August 14th, 1998)
original version by:  Nikos Drakos, CBLU, University of Leeds
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>7.11.1 Hash, BTree and Record Objects </TITLE>
<META NAME="description" CONTENT="7.11.1 Hash, BTree and Record Objects ">
<META NAME="keywords" CONTENT="lib">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<LINK REL="STYLESHEET" HREF="lib.css">
<LINK REL="previous" HREF="module-bsddb.html">
<LINK REL="up" HREF="module-bsddb.html">
<LINK REL="next" HREF="module-zlib.html">
</HEAD>
<BODY bgcolor="#ffffff">
<div class=navigation>
<table align=center width="100%" cellpadding=0 cellspacing=2>
<tr>
<td><A HREF="module-zlib.html"><img width=32 height=32 align=bottom border=0 alt="next"
 src="../icons/next.gif"></A></td>
<td><A HREF="module-bsddb.html"><img width=32 height=32 align=bottom border=0 alt="up"
 src="../icons/up.gif"></A></td>
<td><A HREF="module-bsddb.html"><img width=32 height=32 align=bottom border=0 alt="previous"
 src="../icons/previous.gif"></A></td>
<td align=center bgcolor="#99CCFF" width="100%">
 <b class=title>Python Library Reference</b></td>
<td><A HREF="contents.html"><img width=32 height=32 align=bottom border=0 alt="contents"
 src="../icons/contents.gif"></A></td>
<td><a
 href="modindex.html"><img width=32 height=32 align=bottom border=0 alt="modules"
 src="../icons/modules.gif"></a></td>
<td><A HREF="genindex.html"><img width=32 height=32 align=bottom border=0 alt="index"
 src="../icons/index.gif"></A></td>
</tr></table><b class=navlabel>Next:</b> <span class=sectref><A HREF="module-zlib.html">7.12 zlib  </A></span>
<b class=navlabel>Up:</b> <span class=sectref><A HREF="module-bsddb.html">7.11 bsddb  </A></span>
<b class=navlabel>Previous:</b> <span class=sectref><A HREF="module-bsddb.html">7.11 bsddb  </A></span>
<br><hr></div>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0091110000000000000000"></A>
<BR>
7.11.1 Hash, BTree and Record Objects 
</H2>

<P>
Once instantiated, hash, btree and record objects support the following
methods:

<P>
<dl><dt><b><a name="l2h-1412"><tt class=method>close</tt></a></b> ()
<dd>
Close the underlying file.  The object can no longer be accessed.  Since
there is no open <tt class=method>open</tt> method for these objects, to open the file
again a new <tt class=module>bsddb</tt> module open function must be called.
</dl>

<P>
<dl><dt><b><a name="l2h-1413"><tt class=method>keys</tt></a></b> ()
<dd>
Return the list of keys contained in the DB file.  The order of the list is
unspecified and should not be relied on.  In particular, the order of the
list returned is different for different file formats.
</dl>

<P>
<dl><dt><b><a name="l2h-1414"><tt class=method>has_key</tt></a></b> (<var>key</var>)
<dd>
Return 1 if the DB file contains the argument as a key.
</dl>

<P>
<dl><dt><b><a name="l2h-1415"><tt class=method>set_location</tt></a></b> (<var>key</var>)
<dd>
Set the cursor to the item indicated by the key and return it.
</dl>

<P>
<dl><dt><b><a name="l2h-1416"><tt class=method>first</tt></a></b> ()
<dd>
Set the cursor to the first item in the DB file and return it.  The order of 
keys in the file is unspecified, except in the case of B-Tree databases.
</dl>

<P>
<dl><dt><b><a name="l2h-1417"><tt class=method>next</tt></a></b> ()
<dd>
Set the cursor to the next item in the DB file and return it.  The order of 
keys in the file is unspecified, except in the case of B-Tree databases.
</dl>

<P>
<dl><dt><b><a name="l2h-1418"><tt class=method>previous</tt></a></b> ()
<dd>
Set the cursor to the first item in the DB file and return it.  The
order of keys in the file is unspecified, except in the case of B-Tree
databases.  This is not supported on hashtable databases (those opened
with <tt class=function>hashopen()</tt>).
</dl>

<P>
<dl><dt><b><a name="l2h-1419"><tt class=method>last</tt></a></b> ()
<dd>
Set the cursor to the last item in the DB file and return it.  The
order of keys in the file is unspecified.  This is not supported on
hashtable databases (those opened with <tt class=function>hashopen()</tt>).
</dl>

<P>
<dl><dt><b><a name="l2h-1420"><tt class=method>sync</tt></a></b> ()
<dd>
Synchronize the database on disk.
</dl>

<P>
Example:

<P>
<dl><dd><pre class=verbatim>
&gt;&gt;&gt; import bsddb
&gt;&gt;&gt; db = bsddb.btopen('/tmp/spam.db', 'c')
&gt;&gt;&gt; for i in range(10): db['%d'%i] = '%d'% (i*i)
... 
&gt;&gt;&gt; db['3']
'9'
&gt;&gt;&gt; db.keys()
['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']
&gt;&gt;&gt; db.first()
('0', '0')
&gt;&gt;&gt; db.next()
('1', '1')
&gt;&gt;&gt; db.last()
('9', '81')
&gt;&gt;&gt; db.set_location('2')
('2', '4')
&gt;&gt;&gt; db.previous() 
('1', '1')
&gt;&gt;&gt; db.sync()
0
</pre></dl><p>
<div class=navigation><hr><table align=center width="100%" cellpadding=0 cellspacing=2>
<tr>
<td><A HREF="module-zlib.html"><img width=32 height=32 align=bottom border=0 alt="next"
 src="../icons/next.gif"></A></td>
<td><A HREF="module-bsddb.html"><img width=32 height=32 align=bottom border=0 alt="up"
 src="../icons/up.gif"></A></td>
<td><A HREF="module-bsddb.html"><img width=32 height=32 align=bottom border=0 alt="previous"
 src="../icons/previous.gif"></A></td>
<td align=center bgcolor="#99CCFF" width="100%">
 <b class=title>Python Library Reference</b></td>
<td><A HREF="contents.html"><img width=32 height=32 align=bottom border=0 alt="contents"
 src="../icons/contents.gif"></A></td>
<td><a
 href="modindex.html"><img width=32 height=32 align=bottom border=0 alt="modules"
 src="../icons/modules.gif"></a></td>
<td><A HREF="genindex.html"><img width=32 height=32 align=bottom border=0 alt="index"
 src="../icons/index.gif"></A></td>
</tr></table><b class=navlabel>Next:</b> <span class=sectref><A HREF="module-zlib.html">7.12 zlib  </A></span>
<b class=navlabel>Up:</b> <span class=sectref><A HREF="module-bsddb.html">7.11 bsddb  </A></span>
<b class=navlabel>Previous:</b> <span class=sectref><A HREF="module-bsddb.html">7.11 bsddb  </A></span>
</div>
<!--End of Navigation Panel-->
<ADDRESS>
<hr>Send comments on this document to <a href="mailto:python-docs@python.org">python-docs@python.org</a>.
</ADDRESS>
</BODY>
</HTML>
