diff options
Diffstat (limited to 'cpp')
| -rw-r--r-- | cpp/doc/Properties.sgml | 210 |
1 files changed, 201 insertions, 9 deletions
diff --git a/cpp/doc/Properties.sgml b/cpp/doc/Properties.sgml index a4b9388d2b4..8b228f655b7 100644 --- a/cpp/doc/Properties.sgml +++ b/cpp/doc/Properties.sgml @@ -2793,30 +2793,184 @@ time. <section><title>&Freeze; Properties</title> <!-- ********************************************************************** --> -<section><title>Freeze.Trace.DB</title> +<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbCheckpointPeriod</title> <section><title>Synopsis</title> <synopsis> -Freeze.Trace.DB=<replaceable>num</replaceable> +Freeze.DbEnv.<replaceable>env-name</replaceable>.DbCheckpointPeriod=<replaceable>num</replaceable> </synopsis> </section> <section> <title>Description</title> <para> -The &Freeze; database activity trace level: +Every Berkeley DB environment created by Freeze has an associated +thread that checkpoints this environment every <replaceable>num</replaceable> seconds. +Defaults to 120 seconds. +</para> +</section> +</section> + + +<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbHome</title> +<section><title>Synopsis</title> +<synopsis> +Freeze.DbEnv.<replaceable>env-name</replaceable>.DbHome=<replaceable>db-home</replaceable> +</synopsis> +</section> +<section> +<title>Description</title> +<para> +Defines the home directory of this &Freeze; database +environment. Defaults to <replaceable>env-name</replaceable>. +</para> +</section> +</section> + +<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbPrivate</title> +<section><title>Synopsis</title> +<synopsis> +Freeze.DbEnv.<replaceable>env-name</replaceable>.DbPrivate=<replaceable>num</replaceable> +</synopsis> +</section> +<section> +<title>Description</title> +<para> +If <replaceable>num</replaceable> is set to a value larger than zero, +&Freeze; will instruct Berkeley DB to use process private memory instead of shared +memory. The default value is 1. Set it to 0 in order to run db_archive (or another Berkeley DB utility) on a running environment. +</para> +</section> +</section> + +<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbRecoverFatal</title> +<section><title>Synopsis</title> +<synopsis> +Freeze.DbEnv.<replaceable>env-name</replaceable>.DbRecoverFatal=<replaceable>num</replaceable> +</synopsis> +</section> +<section> +<title>Description</title> +<para> +If <replaceable>num</replaceable> is set to a value larger than zero, +"fatal" recovery will be performed when the environment is opened. The default value is 0. +</para> +</section> +</section> + +<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.OldLogsAutoDelete</title> +<section><title>Synopsis</title> +<synopsis> +Freeze.DbEnv.<replaceable>env-name</replaceable>.OldLogsAutoDelete=<replaceable>num</replaceable> +</synopsis> +</section> +<section> +<title>Description</title> +<para> +If <replaceable>num</replaceable> is set to a value larger than zero, +old transactional logs no longer in use are deleted after each +periodic checkpoint (see +<literal>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbCheckpointPeriod</literal>). The default value is 1. +</para> +</section> +</section> + +<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.PeriodicCheckpointMinSize</title> +<section><title>Synopsis</title> +<synopsis> +Freeze.DbEnv.<replaceable>env-name</replaceable>.PeriodicCheckpointMinSize=<replaceable>num</replaceable> +</synopsis> +</section> +<section> +<title>Description</title> +<para> +<replaceable>num</replaceable> is the minimum size in kbytes for the +periodic checkpoint (see +<literal>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbCheckpointPeriod</literal>). +This value is passed to Berkeley DB's checkpoint function. Defaults to +0 (which means no minimum). +</para> +</section> +</section> + + +<section><title>Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>db-name</replaceable>.MaxTxSize</title> +<section><title>Synopsis</title> +<synopsis> +Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>db-name</replaceable>.MaxTxSize=<replaceable>num</replaceable> +</synopsis> +</section> +<section> +<title>Description</title> +<para> &Freeze; uses a background thread to save updates +to the database. Transactions are used to save many +facets together. <replaceable>num</replaceable> defines the maximum +number of facets saved per transaction. Defaults to 10 * +SaveSizeTrigger (see <literal>Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>db-name</replaceable>.SaveSizeTrigger</literal>); if this value is negative, the actual value is set to 100. +</para> +</section> +</section> + +<section><title>Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>db-name</replaceable>.SavePeriod</title> +<section><title>Synopsis</title> +<synopsis> +Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>db-name</replaceable>.SavePeriod=<replaceable>num</replaceable> +</synopsis> +</section> +<section> +<title>Description</title> +<para> &Freeze; uses a background thread to save updates +to the database. After <replaceable>num</replaceable> milliseconds +without saving, if there is any facet created, modified or destroyed, this background thread wakes up to +save these facets. When <replaceable>num</replaceable> is 0, there is +no periodic saving. Defaults to 60,000. +</para> +</section> +</section> + + +<section><title>Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>db-name</replaceable>.SaveSizeTrigger</title> +<section><title>Synopsis</title> +<synopsis> +Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>db-name</replaceable>.SaveSizeTrigger=<replaceable>num</replaceable> +</synopsis> +</section> +<section> +<title>Description</title> +<para> &Freeze; uses a background thread to save updates +to the database. When <replaceable>num</replaceable> is 0 or positive, +as soon as <replaceable>num</replaceable> or more facets have been +created, modified or destroyed, this background thread wakes up to +save them. When <replaceable>num</replaceable> is negative, there is no size trigger. Defaults to 10. +</para> +</section> +</section> + + + + +<section><title>Freeze.Trace.DbEnv</title> +<section><title>Synopsis</title> +<synopsis> +Freeze.Trace.DbEnv=<replaceable>num</replaceable> +</synopsis> +</section> +<section> +<title>Description</title> +<para> +The &Freeze; database environment activity trace level: <informaltable> <tgroup cols=2> <tbody> <row> <entry>0</entry> -<entry>No database activity trace. (default)</entry> +<entry>No database environment activity trace. (default)</entry> </row> <row> <entry>1</entry> -<entry>Trace database activity.</entry> +<entry>Trace database open and close.</entry> </row> <row> <entry>2</entry> -<entry>Also trace database transactions.</entry> +<entry>Also trace checkpoints and the removal of old log files.</entry> </row> </tbody> </tgroup> @@ -2844,12 +2998,16 @@ The &Freeze; evictor activity trace level: </row> <row> <entry>1</entry> -<entry>Trace &Ice; object creation and destruction, as well as -evictor deactivation.</entry> +<entry>Trace &Ice; object and facet creation and destruction, facet streaming time, facet saving time, object eviction +(every 50 objects) and evictor deactivation.</entry> </row> <row> <entry>2</entry> -<entry>Also trace evictor queue activity.</entry> +<entry>Also trace object lookups, and all object evictions.</entry> +</row> +<row> +<entry>3</entry> +<entry>Also trace object retrieval from the database.</entry> </row> </tbody> </tgroup> @@ -2858,4 +3016,38 @@ evictor deactivation.</entry> </section> </section> +<section><title>Freeze.Trace.Map</title> +<section><title>Synopsis</title> +<synopsis> +Freeze.Trace.Map=<replaceable>num</replaceable> +</synopsis> +</section> +<section> +<title>Description</title> +<para> +The &Freeze; map activity trace level: +<informaltable> +<tgroup cols=2> +<tbody> +<row> +<entry>0</entry> +<entry>No map activity trace. (default)</entry> +</row> +<row> +<entry>1</entry> +<entry>Trace database open and close.</entry> +</row> +<row> +<entry>2</entry> +<entry>Also trace iterator and transaction operations, and reference +counting of the underlying database.</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</para> +</section> +</section> + + </section> |