Skip to content

Commit b58711e

Browse files
committed
[feature] Add some detail about disabling the Lock Table
1 parent 2284211 commit b58711e

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

src/main/xar-resources/data/configuration/configuration.xml

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
xmlns:xlink="http://www.w3.org/1999/xlink">
66
<info>
77
<title>Application Server Configuration</title>
8-
<date>2Q19</date>
8+
<date>3Q19</date>
99
<keywordset>
1010
<keyword>operations</keyword>
1111
</keywordset>
@@ -34,6 +34,12 @@
3434
<para>Configures the storage back-end.</para>
3535
</listitem>
3636
</varlistentry>
37+
<varlistentry>
38+
<term> <tag>lock-manager</tag> </term>
39+
<listitem>
40+
<para>Configures the Lock Manager.</para>
41+
</listitem>
42+
</varlistentry>
3743
<varlistentry>
3844
<term> <tag>repository</tag> </term>
3945
<listitem>
@@ -432,6 +438,27 @@
432438
</sect3>
433439
</sect2>
434440

441+
442+
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
443+
<sect2 xml:id="lock-manager">
444+
<title> <tag>lock-manager</tag> element</title>
445+
<para>This element contains settings for eXist-db's Lock Manager and Lock Table. The majority
446+
of these Lock Manager settings should not be modified unless otherwise suggested by eXist-db Core Development Team.</para>
447+
<variablelist spacing="compact">
448+
<varlistentry>
449+
<term> <code>lock-table/@disabled</code> </term>
450+
<listitem>
451+
<para>Disables the database Lock Table which tracks database locks. The Lock Table is enabled by default
452+
and allows reporting on database locking via JMX.</para>
453+
<para>Tracking locks via the Lock Table imposes a small overhead per-Lock. Once users
454+
have finished testing their system to ensure correct operation, they may wish to disable
455+
this in production to ensure the absolute best performance.</para>
456+
<note><para>Unless nessecary, it is recommened to leave this enabled.</para></note>
457+
</listitem>
458+
</varlistentry>
459+
</variablelist>
460+
</sect2>
461+
435462
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
436463

437464
<sect2 xml:id="indexer">

src/main/xar-resources/data/production_good_practice/production_good_practice.xml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
xmlns:xlink="http://www.w3.org/1999/xlink">
66
<info>
77
<title>Production Use - Good Practice</title>
8-
<date>2Q19</date>
8+
<date>3Q19</date>
99
<keywordset>
1010
<keyword>operations</keyword>
1111
</keywordset>
@@ -380,6 +380,9 @@
380380
<para>Keeping the eXist-db application, data and journal on separate disks, connected to
381381
different I/O channels, can have a positive impact on performance. The location of
382382
the data files and journals can be changed in <literal>etc/conf.xml</literal>.</para>
383+
<para>In addition to gain the absolute best performance, for eXist-db 5.0.0 or newer, it
384+
may be beneficial to disable Lock Event Tracking in the Lock Table. The Lock Table
385+
can be disabled in the <literal>etc/conf.xml</literal> configuration file.</para>
383386
</sect2>
384387
</sect1>
385388

0 commit comments

Comments
 (0)