head 1.2;
access;
symbols
RPM_4_2_1:1.1.1.5
RPM_4_2:1.1.1.5
RPM_4_1_1:1.1.1.5
RPM_4_1:1.1.1.4
RPM_4_0_5:1.1.1.3
RPM_4_0_4:1.1.1.2
RPM_4_0_3:1.1.1.1
RPM:1.1.1;
locks; strict;
comment @# @;
1.2
date 2008.01.02.09.52.51; author rse; state dead;
branches;
next 1.1;
commitid z4cpSiAhOCXk5PLs;
1.1
date 2001.07.23.20.45.36; author rse; state Exp;
branches
1.1.1.1;
next ;
1.1.1.1
date 2001.07.23.20.45.36; author rse; state Exp;
branches;
next 1.1.1.2;
1.1.1.2
date 2002.01.08.00.30.08; author rse; state Exp;
branches;
next 1.1.1.3;
1.1.1.3
date 2003.01.18.13.48.55; author rse; state Exp;
branches;
next 1.1.1.4;
1.1.1.4
date 2001.12.06.00.07.57; author rse; state Exp;
branches;
next 1.1.1.5;
1.1.1.5
date 2003.01.18.14.04.56; author rse; state Exp;
branches;
next ;
desc
@@
1.2
log
@remove the ancient RPM 4.2.1 source tree copy
@
text
@
Berkeley DB: DB->stat
DB->stat
|
 
|
#include <db.h>
int
DB->stat(DB *db, void *sp, u_int32_t flags);
Description
The DB->stat function 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 created in allocated memory. If application-specific allocation
routines have been declared (see DB_ENV->set_alloc for more
information), they are used to allocate the memory; otherwise, the
library function 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.
The flags value must be set to 0 or
one of the following values:
- DB_CACHED_COUNTS
- Return a cached count of the keys and records in a database.
The DB_CACHED_COUNTS flag has been deprecated in
favor of the DB_FAST_STAT flag. Please update your
applications.
- DB_FAST_STAT
- Return only the values which do not require traversal of the database.
Fields returned when this flag is set are noted with an asterisk (*)
below.
Among other things, this flag makes it possible for applications to
request key and record counts without incurring the performance penalty
of traversing the entire database. If the underlying database is of
type Recno, or of type Btree and the database was created with the
DB_RECNUM flag, the count of keys will be exact. Otherwise,
the count of keys will be the value saved the last time the database
was traversed, or 0 if no count of keys has ever been made. If the
underlying database is of type Recno, the count of data items will be
exact, otherwise, the count of data items will be the value saved the
last time the database was traversed, or 0 if no count of data items
has ever been done.
- DB_RECORDCOUNT
- Return a count of the records in a Btree or Recno Access Method
database. The DB_RECORDCOUNT flag has been
deprecated in favor of the DB_FAST_STAT flag. Please update
your applications.
If the DB_FAST_STAT flag has not been specified, the
DB->stat function will access some of or all the pages in the database,
incurring a severe performance penalty as well as possibly flushing the
underlying buffer pool.
In the presence of multiple threads or processes accessing an active
database, the information returned by DB->stat may be out-of-date.
If the database was not opened read-only and the DB_FAST_STAT
flag was not specified, the cached key and record numbers will be
updated after the statistical information has been gathered.
The DB->stat function 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 DB->stat function returns a non-zero error value on failure and 0 on success.
Hash Statistics
In the case of a Hash database,
the statistics are stored in a structure of type DB_HASH_STAT. The
following fields will be filled in:
- u_int32_t hash_magic*
- Magic number that identifies the file as a Hash file.
- u_int32_t hash_version*
- The version of the Hash database.
- u_int32_t hash_nkeys*
- The number of unique keys in the database. If DB_FAST_STAT was
specified the count will be the last saved value unless it has never
been calculated, in which case it will be 0.
- u_int32_t hash_ndata*
- The number of key/data pairs in the database. If DB_FAST_STAT
was specified the count will be the last saved value unless it has never
been calculated, in which case it will be 0.
- u_int32_t hash_pagesize*
- The underlying Hash database page (and bucket) size, in bytes.
- u_int32_t hash_nelem*
- The estimated size of the hash table specified at database-creation time.
- u_int32_t hash_ffactor*
- The desired fill factor (number of items per bucket) specified at
database-creation time.
- u_int32_t hash_buckets*
- The number of hash buckets.
- u_int32_t hash_free
- The number of pages on the free list.
- u_int32_t hash_bfree
- The number of bytes free on bucket pages.
- u_int32_t hash_bigpages
- The number of big key/data pages.
- u_int32_t hash_big_bfree
- The number of bytes free on big item pages.
- u_int32_t hash_overflows
- The number of overflow pages (overflow pages are pages that contain items
that did not fit in the main bucket page).
- u_int32_t hash_ovfl_free
- The number of bytes free on overflow pages.
- u_int32_t hash_dup
- The number of duplicate pages.
- u_int32_t hash_dup_free
- The number of bytes free on duplicate pages.
Btree and Recno Statistics
In the case of a Btree or Recno database,
the statistics are stored in a structure of type DB_BTREE_STAT. The
following fields will be filled in:
- u_int32_t bt_magic*
- Magic number that identifies the file as a Btree database.
- u_int32_t bt_version*
- The version of the Btree database.
- u_int32_t bt_nkeys*
- For the Btree Access Method, the number of unique keys in the database.
If DB_FAST_STAT was specified and the database was created with
the DB_RECNUM flag, the count will be exact, otherwise, the
count will be the last saved value unless it has never been calculated,
in which case it will be 0.
For the Recno Access Method, the exact number of records in the
database.
- u_int32_t bt_ndata*
- For the Btree Access Method, the number of key/data pairs in the
database. If DB_FAST_STAT was specified the count will be the
last saved value unless it has never been calculated, in which case it
will be 0.
For the Recno Access Method, the exact number of records in the
database. If the database has been configured to not renumber records
during deletion, the count of records will only reflect undeleted
records.
- u_int32_t bt_pagesize*
- Underlying database page size, in bytes.
- u_int32_t bt_minkey*
- The minimum keys per page.
- u_int32_t bt_re_len*
- The length of fixed-length records.
- u_int32_t bt_re_pad*
- The padding byte value for fixed-length records.
- u_int32_t bt_levels
- Number of levels in the database.
- u_int32_t bt_int_pg
- Number of database internal pages.
- u_int32_t bt_leaf_pg
- Number of database leaf pages.
- u_int32_t bt_dup_pg
- Number of database duplicate pages.
- u_int32_t bt_over_pg
- Number of database overflow pages.
- u_int32_t bt_free
- Number of pages on the free list.
- u_int32_t bt_int_pgfree
- Number of bytes free in database internal pages.
- u_int32_t bt_leaf_pgfree
- Number of bytes free in database leaf pages.
- u_int32_t bt_dup_pgfree
- Number of bytes free in database duplicate pages.
- u_int32_t bt_over_pgfree
- Number of bytes free in database overflow pages.
Queue Statistics
In the case of a Queue database,
the statistics are stored in a structure of type DB_QUEUE_STAT. The
following fields will be filled in:
- u_int32_t qs_magic*
- Magic number that identifies the file as a Queue file.
- u_int32_t qs_version*
- The version of the Queue file type.
- u_int32_t qs_nkeys*
- The number of records in the database. If DB_FAST_STAT was
specified the count will be the last saved value unless it has never
been calculated, in which case it will be 0.
- u_int32_t qs_ndata*
- The number of records in the database. If DB_FAST_STAT was
specified the count will be the last saved value unless it has never
been calculated, in which case it will be 0.
- u_int32_t qs_pagesize*
- Underlying database page size, in bytes.
- u_int32_t qs_extentsize*
- Underlying database extent size, in pages.
- u_int32_t qs_pages
- Number of pages in the database.
- u_int32_t qs_re_len*
- The length of the records.
- u_int32_t qs_re_pad*
- The padding byte value for the records.
- u_int32_t qs_pgfree
- Number of bytes free in database pages.
- u_int32_t qs_start
- Start offset.
- u_int32_t qs_first_recno*
- First undeleted record in the database.
- u_int32_t qs_cur_recno*
- Last allocated record number in the database.
The DB->stat function returns a non-zero error value on failure and 0 on success.
Errors
The DB->stat function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the DB->stat function may fail and return
DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail
in the same way.
See Also
db_create,
DB->associate,
DB->close,
DB->cursor,
DB->del,
DB->err, DB->errx
DB->fd,
DB->get,
DB->pget,
DB->get_byteswapped,
DB->get_type,
DB->join,
DB->key_range,
DB->open,
DB->put,
DB->remove,
DB->rename,
DB->set_alloc,
DB->set_append_recno,
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_feedback,
DB->set_flags,
DB->set_h_ffactor,
DB->set_h_hash,
DB->set_h_nelem,
DB->set_lorder,
DB->set_pagesize,
DB->set_paniccall,
DB->set_q_extentsize,
DB->set_re_delim,
DB->set_re_len,
DB->set_re_pad,
DB->set_re_source,
DB->stat,
DB->sync,
DB->truncate,
DB->upgrade,
and
DB->verify.
Copyright Sleepycat Software
@
1.1
log
@Initial revision
@
text
@d1 1
a1 1
@
1.1.1.1
log
@Import: RPM 4.0.3
@
text
@@
1.1.1.2
log
@Import: RPM 4.0.4
@
text
@d1 1
a1 1
d162 1
@
1.1.1.3
log
@Import: RPM 4.0.5
@
text
@d1 2
a2 2
a3 1
d28 1
a28 1
The DB->stat method creates a statistical structure and
d35 1
a35 1
library malloc(3) interface is used. The caller is
d42 4
d60 4
d66 1
a66 1
DB->stat method will access some of or all the pages in the database,
d74 1
a74 1
The DB->stat method cannot be transaction-protected. For this reason,
d77 1
a77 1
The DB->stat method returns a non-zero error value on failure and 0 on success.
d92 1
d163 1
a163 1
u_int32_t qs_cur_recno*Next available record number.
d165 1
a165 1
The DB->stat method returns a non-zero error value on failure and 0 on success.
d167 4
a170 6
The DB->stat method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the DB->stat method may fail and
return DB_RUNRECOVERY,
in which case all subsequent Berkeley DB calls will fail in the same way.
Class
DB
d172 46
a217 1
Databases and Related Methods
@
1.1.1.4
log
@Import: RPM 4.1
@
text
@d1 2
a2 2
d4 1
d29 1
a29 1
The DB->stat function creates a statistical structure and
d36 1
a36 1
library function malloc(3) is used. The caller is
a42 4
DB_CACHED_COUNTSReturn a cached count of the keys and records in a database.
The DB_CACHED_COUNTS flag has been deprecated in
favor of the DB_FAST_STAT flag. Please update your
applications.
a56 4
DB_RECORDCOUNTReturn a count of the records in a Btree or Recno Access Method
database. The DB_RECORDCOUNT flag has been
deprecated in favor of the DB_FAST_STAT flag. Please update
your applications.
d59 1
a59 1
DB->stat function will access some of or all the pages in the database,
d67 1
a67 1
The DB->stat function cannot be transaction-protected. For this reason,
d70 1
a70 1
The DB->stat function returns a non-zero error value on failure and 0 on success.
a84 1
u_int32_t hash_nelem*The estimated size of the hash table specified at database-creation time.
d155 1
a155 1
u_int32_t qs_cur_recno*Last allocated record number in the database.
d157 1
a157 1
The DB->stat function returns a non-zero error value on failure and 0 on success.
d159 6
a164 4
The DB->stat function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the DB->stat function may fail and return
DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail
in the same way.
d166 1
a166 46
db_create,
DB->associate,
DB->close,
DB->cursor,
DB->del,
DB->err, DB->errx
DB->fd,
DB->get,
DB->pget,
DB->get_byteswapped,
DB->get_type,
DB->join,
DB->key_range,
DB->open,
DB->put,
DB->remove,
DB->rename,
DB->set_alloc,
DB->set_append_recno,
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_feedback,
DB->set_flags,
DB->set_h_ffactor,
DB->set_h_hash,
DB->set_h_nelem,
DB->set_lorder,
DB->set_pagesize,
DB->set_paniccall,
DB->set_q_extentsize,
DB->set_re_delim,
DB->set_re_len,
DB->set_re_pad,
DB->set_re_source,
DB->stat,
DB->sync,
DB->truncate,
DB->upgrade,
and
DB->verify.
@
1.1.1.5
log
@Import: RPM 4.1.1
@
text
@d1 2
a2 2
a3 1
d28 1
a28 1
The DB->stat method creates a statistical structure and
d35 1
a35 1
library malloc(3) interface is used. The caller is
d42 4
d60 4
d66 1
a66 1
DB->stat method will access some of or all the pages in the database,
d74 1
a74 1
The DB->stat method cannot be transaction-protected. For this reason,
d77 1
a77 1
The DB->stat method returns a non-zero error value on failure and 0 on success.
d92 1
d163 1
a163 1
u_int32_t qs_cur_recno*Next available record number.
d165 1
a165 1
The DB->stat method returns a non-zero error value on failure and 0 on success.
d167 4
a170 6
The DB->stat method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the DB->stat method may fail and
return DB_RUNRECOVERY,
in which case all subsequent Berkeley DB calls will fail in the same way.
Class
DB
d172 46
a217 1
Databases and Related Methods
@