Update explanation of the set_location() method to indicate that in
BTree databases, the key need not be in the database. Also, tell about the exception if the key is not in the DB for other DB types. This closes SF bug #127377.
This commit is contained in:
parent
a4d18a008f
commit
e1d4715a6f
|
@ -103,7 +103,13 @@ Return \code{1} if the DB file contains the argument as a key.
|
|||
\end{methoddesc}
|
||||
|
||||
\begin{methoddesc}{set_location}{key}
|
||||
Set the cursor to the item indicated by the key and return it.
|
||||
Set the cursor to the item indicated by \var{key} and return a tuple
|
||||
containing the key and its value. For binary tree databases (opened
|
||||
using \function{btopen()}), if \var{key} does not actually exist in
|
||||
the database, the cursor will point to the next item in sorted order
|
||||
and return that key and value. For other databases,
|
||||
\exception{KeyError} will be raised if \var{key} is not found in the
|
||||
database.
|
||||
\end{methoddesc}
|
||||
|
||||
\begin{methoddesc}{first}{}
|
||||
|
|
Loading…
Reference in New Issue