Edit File - File Manager

Edit File: seq_get.html

<html>
<head>
<title>Berkeley DB: DB_SEQUENCE-&gt;get</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>
DB_SEQUENCE-&gt;get
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db.h&gt;

int
DB_SEQUENCE-&gt;get(DB_SEQUENCE *seq,
 DB_TXN *txnid, int32_t delta, db_seq_t *retp, u_int32_t flags);
</pre>
<hr size=1 noshade>
Description: DB_SEQUENCE-&gt;get
The DB_SEQUENCE-&gt;get method returns the next available element in the sequence
and changes the sequence value by delta. The value of
delta must be greater than zero. If there are enough cached
values in the sequence handle then they will be returned. Otherwise the
next value will be fetched from the database and incremented
(decremented) by enough to cover the delta and the next batch
of cached values.
For maximum concurrency a non-zero cache size should be specified prior
to opening the sequence handle and <a href="../../db4-devel-4.7.25/api_c/env_set_flags.html#DB_TXN_NOSYNC">DB_TXN_NOSYNC</a> should be
specified for each DB_SEQUENCE-&gt;get method call.
By default, sequence ranges do not wrap; to cause the sequence to wrap
around the beginning or end of its range, specify the <a href="../../db4-devel-4.7.25/api_c/seq_set_flags.html#DB_SEQ_WRAP">DB_SEQ_WRAP</a>
flag to the <a href="../../db4-devel-4.7.25/api_c/seq_set_flags.html">DB_SEQUENCE-&gt;set_flags</a> method.
The DB_SEQUENCE-&gt;get method will return EINVAL if the record in the database is not a valid sequence
record, or the sequence has reached the beginning or end of its range
and is not configured to wrap.

Parameters 
 delta<ul compact><li>Specifies the amount to increment or decrement the sequence.</ul>
 flags<ul compact><li>The flags parameter must be set to 0 or by bitwise inclusively OR'ing together one
or more of the following values:
 
<a name="DB_TXN_NOSYNC">DB_TXN_NOSYNC</a><ul compact><li>If the operation is implicitly transaction protected (the txnid
argument is NULL but the operation occurs to a transactional database),
do not synchronously flush the log when the transaction commits.</ul>
 </ul>
 retp<ul compact><li>retp points to the memory to hold the return value from
the sequence.</ul>
 txnid<ul compact><li>If the operation is part of an application-specified transaction, the
txnid parameter is a transaction handle returned from
<a href="../../db4-devel-4.7.25/api_c/txn_begin.html">DB_ENV-&gt;txn_begin</a>; if the operation is part of a Berkeley DB Concurrent Data Store group, the
txnid parameter is a handle returned from
<a href="../../db4-devel-4.7.25/api_c/env_cdsgroup_begin.html">DB_ENV-&gt;cdsgroup_begin</a>; otherwise NULL.
If no transaction handle is
specified, but the
operation occurs in a transactional
database,
the operation will be implicitly transaction protected.
No txnid handle may be specified if the sequence handle was
opened with a non-zero cache size.
If the underlying database handle was opened in a transaction, calling
DB_SEQUENCE-&gt;get may result in changes to the sequence object; these
changes will be automatically committed in a transaction internal to the
Berkeley DB library. If the thread of control calling DB_SEQUENCE-&gt;get has
an active transaction, which holds locks on the same database as the
one in which the sequence object is stored, it is possible for a thread
of control calling DB_SEQUENCE-&gt;get to self-deadlock because the active
transaction's locks conflict with the internal transaction's locks.
For this reason, it is often preferable for sequence objects to be
stored in their own database.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_c/seq_class.html">DB_SEQUENCE</a>
 See Also
<a href="../../db4-devel-4.7.25/api_c/seq_list.html">Sequences and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager