Edit File - File Manager

Edit File: seq_stat.html

<html>
<head>
<title>Berkeley DB: DbSequence::stat</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>
DbSequence::stat
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/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_cxx.h&gt;

int
Db::stat(void *sp, u_int32_t flags);

int
Db::stat_print(u_int32_t flags);
</pre>
<hr size=1 noshade>
Description: DbSequence::stat
The DbSequence::stat method creates a statistical structure and copies a
pointer to it into user-specified memory locations. Specifically, if
sp is non-NULL, a pointer to the statistics for the database are
copied into the memory location to which it refers.
Statistical structures are stored in allocated memory. If application-specific allocation
routines have been declared (see <a href="../../db4-devel-4.7.25/api_cxx/env_set_alloc.html">DbEnv::set_alloc</a> for more
information), they are used to allocate the memory; otherwise, the
standard C library malloc(3) is used. The caller is
responsible for deallocating the memory. To deallocate the memory, free
the memory reference; references inside the returned memory need not be
individually freed.
In the presence of multiple threads or processes accessing an active
sequence, the information returned by DbSequence::stat may be out-of-date.
The DbSequence::stat method cannot be transaction-protected. For this reason,
it should be called in a thread of control that has no open cursors or
active transactions.
The statistics are stored in a structure of type DB_SEQUENCE_STAT. The
following fields will be filled in:
 
u_int32_t st_wait;<ul compact><li>The number of times a thread of control was forced to wait on the
handle mutex.</ul>
u_int32_t st_nowait;<ul compact><li>The number of times that a thread of control was able to obtain handle
mutex without waiting.</ul>
db_seq_t st_current;<ul compact><li>The current value of the sequence in the database.</ul>
db_seq_t st_value;<ul compact><li>The current cached value of the sequence.</ul>
db_seq_t st_last_value;<ul compact><li>The last cached value of the sequence.</ul>
db_seq_t st_min;<ul compact><li>The minimum permitted value of the sequence.</ul>
db_seq_t st_max;<ul compact><li>The maximum permitted value of the sequence.</ul>
int32_t st_cache_size;<ul compact><li>The number of values that will be cached in this handle.</ul>
u_int32_t st_flags;<ul compact><li>The flags value for the sequence.</ul>
 
Parameters 
 flags<ul compact><li>The flags parameter must be set by bitwise inclusively OR'ing together one or more
of the following values:
 
<a name="DB_STAT_CLEAR">DB_STAT_CLEAR</a><ul compact><li>Reset statistics after printing their values.</ul>
 </ul>
 
The DbSequence::stat method may not be called before the <a href="../../db4-devel-4.7.25/api_cxx/seq_open.html">DbSequence::open</a> method has
been called.
The DbSequence::stat method
either returns a non-zero error value
or throws an exception that encapsulates a non-zero error value on
failure, and returns 0 on success.

<hr size=1 noshade>
Description: DbSequence::stat_print
The DbSequence::stat_print method prints diagnostic information to the output
channel described by the <a href="../../db4-devel-4.7.25/api_cxx/env_set_msgfile.html">DbEnv::set_msgfile</a> method.
Parameters 
 flags<ul compact><li>The flags parameter must be set by bitwise inclusively OR'ing together one or more
of the following values:
 
<a name="DB_STAT_CLEAR">DB_STAT_CLEAR</a><ul compact><li>Reset statistics after printing their values.</ul>
 </ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_cxx/seq_class.html">DbSequence</a>
 See Also
<a href="../../db4-devel-4.7.25/api_cxx/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_cxx/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