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