db_stat.1   [plain text]


.Dd December 3, 2003       \" DATE 
.Dt db_stat 1       \" Program name and manual section number 
.Os Darwin
.Sh NAME                 \" Section Header - required - don't modify 
.Nm db_stat
.\" The following lines are read in generating the apropos(man -k) database. Use only key
.\" words here as the database is built based on the words here and in the .ND line. 
.\" Use .Nm macro to designate other names for the documented program.
.Sh SYNOPSIS             \" Section Header - required - don't modify
.Nm Fl d Ar file
.Op Fl fN
.Op Fl h Ar home
.Op Fl P Ar password
.Op Fl s Ar database
.Nm 
.Op Fl celmNrtVZ
.Op Fl C Ar Aclmop
.Op Fl h Ar home
.Op Fl M Ar Ahm
.Op Fl P Ar password
.Sh DESCRIPTION          \" Section Header - required - don't modify
The
.Nm
utility utility displays statistics for Berkeley DB environments.
.Pp
The options are as follows:
.Bl -tag -width
.It Fl C
Display internal information about the lock region. (The output from this option is often both voluminous and meaningless, and is intended only for debugging.)
.Bl -tag -width
.It A
Display all information.
.It c
Display lock conflict matrix.
.It l
Display lockers within hash chains.
.It m
Display region memory information.
.It o
Display objects within hash chains.
.It p
Display lock region parameters.
.El
.It Fl c
Display lock region statistics, as described in DB_ENV->lock_stat.
.It Fl d
Display database statistics for the specified file, as described in DB->stat.
.Pp
If the database contains multiple databases and the -s flag is not specified, the statistics are for the internal database that describes the other databases the file contains, and not for the file as a whole.
.It Fl e
Display current environment statistics.
.It Fl f
Display only those database statistics that can be acquired without traversing the database.
.It Fl h
Specify a home directory for the database environment; by default, the current working directory is used.
.It Fl l
Display log region statistics, as described in DB_ENV->log_stat.
.It Fl M
Display internal information about the shared memory buffer pool. (The output from this option is often both voluminous and meaningless, and is intended only for debugging.)
.Bl -tag -width
.It A
Display all information.
.It h
Display buffers within hash chains.
.It m
Display region memory information.
.El
.It Fl m
Display shared memory buffer pool statistics, as described in DB_ENV->memp_stat.
.It Fl N
Do not acquire shared region mutexes while running. Other problems, such as potentially fatal errors in Berkeley DB, will be ignored as well. This option is intended only for debugging errors, and should not be used under any other circumstances.
.It Fl P
Specify an environment password. Although Berkeley DB utilities overwrite password strings as soon as possible, be aware there may be a window of vulnerability on systems where unprivileged users can see command-line arguments or where utilities are not able to overwrite the memory containing the command-line arguments.
.It Fl r
Display replication statistics, as described in DB_ENV->rep_stat.
.It Fl s
Display statistics for the specified database contained in the file specified with the -d flag.
.It Fl t
Display transaction region statistics, as described in DB_ENV->txn_stat.
.It Fl V
Write the library version number to the standard output, and exit.
.It Fl Z
Reset the statistics after reporting them; valid only with the -c, -e, -l, -m, and -t options.
.El
.Pp
Values normally displayed in quantities of bytes are displayed as a combination of gigabytes (GB), megabytes (MB), kilobytes (KB), and bytes (B). Otherwise, values smaller than 10 million are displayed without any special notation, and values larger than 10 million are displayed as a number followed by "M".
.Pp
The
.Nm
utility may be used with a Berkeley DB environment (as described for the -h option, the environment variable DB_HOME, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment,
.Nm
should always be given the chance to detach from the environment and exit gracefully. To cause
.Nm
to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT).
.Pp
The 
.Nm
utility exits 0 on success, and >0 if an error occurs.
.Pp
.Sh ENVIRONMENT      \" May not be needed
.Bl -tag -width "DB_HOME" \" ENV_VAR_1 is width of the string ENV_VAR_1
.It Ev DB_HOME
If the -h option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open.
.El                      
.\" .Sh FILES                \" File used or created by the topic of the man page
.\" .Bl -tag -width "/Users/joeuser/Library/really_long_file_name" -compact
.\" .It Pa /usr/share/file_name
.\" FILE_1description
.\" .It Pa /Users/joeuser/Library/really_long_file_name
.\" FILE_2 description
.\" .Sh DIAGNOSTICS       \" May not be needed
.\" .Bl -diag
.\" .It Diagnostic Tag
.\" Diagnostic informtion here.
.\" .It Diagnostic Tag
.\" Diagnostic informtion here.
.\" .El
.Sh SEE ALSO 
.Xr db_archive 1 ,
.Xr db_checkpoint 1 ,
.Xr db_deadlock 1 ,
.Xr db_dump 1 ,
.Xr db_load 1 ,
.Xr db_printlog 1 ,
.Xr db_recover 1 ,
.Xr db_upgrade 1 ,
.Xr db_verify 1
.\" .Sh BUGS              \" Document known, unremedied bugs 
.\" .Sh HISTORY           \" Document history if command behaves in a unique manner