DB->join
|

|
#include <db.h>
int
DB->join(DB *primary,
DBC **curslist, DBC **dbcp, u_int32_t flags);
Description
The DB->join function creates a specialized cursor for use in performing
joins on secondary indices. Your data must be organized in the following
manner in order to take advantage of this:
- The actual data should be stored in the database represented by the
DB object used to invoke this function. Hereafter, this
DB object will be called the primary.
- Secondary indices should be stored in separate database files, whose keys
are the values of the secondary indices and whose data items are the
primary keys corresponding to the records having the designated secondary
key value. It is acceptable (and expected) that there may be duplicate
entries in the secondary indices.
These duplicate entries should be sorted for performance reasons, although
it is not required. For more information see the DB_DUPSORT flag
to the DB->set_flags function.
The primary argument contains the DB handle of the
primary database, which is keyed by the data values found in entries
in the curslist.
The curslist argument contains a NULL terminated array of
cursors. Each cursor must have been initialized to reference the key
on which the underlying database should be joined. Typically, this
initialization is done by a DBcursor->c_get call with the DB_SET
flag specified.
The flags parameter is currently unused, and must be set to 0.
The newly created cursor is returned in the memory location referenced
by dbcp.
The returned cursor has the standard cursor functions, that behave as
follows:
- DBcursor->c_get
- Iterates over the values associated with the keys to which each item in
curslist has been initialized. Any data value which appears in
all items specified by the curslist argument is then used as a
key into the primary, and the key/data pair found in the
primary is returned.
The flags parameter must be set to 0 or the following value:
- DB_JOIN_ITEM
- Do not use the data value found in all of the cursors as a lookup
key for the primary, but simply return it in the key parameter
instead. The data parameter is left unchanged.
In addition, the following value may be set by bitwise inclusively OR'ing it into the
flags parameter:
- DB_RMW
- Acquire write locks instead of read locks when doing the retrieval.
Setting this flag may decrease the likelihood of deadlock during a
read-modify-write cycle by immediately acquiring the write lock during
the read part of the cycle so that another thread of control acquiring
a read lock for the same item, in its own read-modify-write cycle, will
not result in deadlock.
- DBcursor->c_put
- Returns EINVAL.
- DBcursor->c_del
- Returns EINVAL.
- DBcursor->c_close
- Close the cursor and release all resources. (Closing the
cursors in curslist is the responsibility of the caller.)
In a transaction protected environment, all of the cursors listed in
curslist must have been created within the same transaction.
The DB->join
function returns a non-zero error value on failure and 0 on success.
Errors
If a fatal error occurs in Berkeley DB, the DB->join function will fail and return
DB_RUNRECOVERY, at which point all subsequent database calls will
fail in the same way.
In addition, the DB->join
function may fail and return a non-zero error
for the following conditions:
- EINVAL
- An invalid flag value or parameter was specified.
The DBcursor->c_put or DBcursor->c_del functions were called.
In addition, the DB->join function may fail and
return a non-zero error
for errors specified for other Berkeley DB and C library or system functions.
See Also
db_create,
DB->close,
DB->cursor,
DB->del,
DB->err,
DB->fd,
DB->get,
DB->get_byteswapped,
DB->get_type,
DB->join,
DB->open,
DB->put,
DB->remove,
DB->set_bt_compare,
DB->set_bt_minkey,
DB->set_bt_prefix,
DB->set_cachesize,
DB->set_dup_compare,
DB->set_errcall,
DB->set_errfile,
DB->set_errpfx,
DB->set_flags,
DB->set_h_ffactor,
DB->set_h_hash,
DB->set_h_nelem,
DB->set_lorder,
DB->set_malloc,
DB->set_pagesize,
DB->set_paniccall,
DB->set_realloc,
DB->set_re_delim,
DB->set_re_len,
DB->set_re_pad,
DB->set_re_source,
DB->stat,
DB->sync
and
DB->upgrade.
Copyright Sleepycat Software