db_get_join.html   [plain text]


<!--$Id: db_get_join.so,v 11.18 2002/08/18 21:17:25 bostic Exp $-->
<!--$Id: m4.tcl,v 11.28 2004/12/16 19:13:05 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: db get_join</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<b><i>db</i> <b>get_join</b></b>
</td>
<td align=right>
<a href="../api_tcl/api_tcl.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<b><pre>db get_join
	[-txn txnid]
	{<i>db</i> key}
	{<i>db</i> key}
	...
</pre></b>
<b>Description(db get_join)</b>
<p>The <i>db</i> <b>get_join</b> command performs the cursor operations required to
join the specified keys and returns a list of joined {key data} pairs.
See <a href="../ref/am/join.html">Equality join</a> for more information on
the underlying requirements for joining.</p>
<p>The options are as follows:</p>
<br>
<b>-txn txnid</b><ul compact><li>If the operation is part of an application-specified transaction, the
<b>txnid</b> parameter is a transaction handle returned from
<i>env</i> <b>txn</b>.  If no transaction handle is specified, but the
operation occurs in a transactional
database,
the operation will be implicitly transaction protected.</ul>
<br>
<p>In the case of error, a Tcl error is thrown.</p>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_tcl/api_tcl.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
</body>
</html>