5:42 a.m.
Author: hardy.ferentschik
Date: 2007-07-24 05:42:02 -0400 (Tue, 24 Jul 2007)
New Revision: 12799
Modified:
trunk/HibernateExt/search/doc/reference/en/master.xml
trunk/HibernateExt/search/doc/reference/en/modules/configuration.xml
trunk/HibernateExt/search/doc/reference/en/modules/lucene-native.xml
trunk/HibernateExt/search/doc/reference/en/modules/mapping.xml
Log:
HSEARCH-67.
Updated documentation adding the new Lucene indexing parameters.
Added $Id:$ for keyword substitution.
Modified: trunk/HibernateExt/search/doc/reference/en/master.xml
===================================================================
--- trunk/HibernateExt/search/doc/reference/en/master.xml 2007-07-24 09:40:30 UTC (rev
12798)
+++ trunk/HibernateExt/search/doc/reference/en/master.xml 2007-07-24 09:42:02 UTC (rev
12799)
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Id$ -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN"
"../../../../../Hibernate3/doc/reference/support/docbook-dtd/docbookx.dtd" [
<!ENTITY architecture SYSTEM "modules/architecture.xml">
@@ -21,7 +22,7 @@
<mediaobject>
<imageobject>
- <imagedata fileref="images/hibernate_logo_a.png"
format="png" />
+ <imagedata fileref="images/hibernate_logo_a.png"
format="PNG" />
</imageobject>
</mediaobject>
</bookinfo>
Property changes on: trunk/HibernateExt/search/doc/reference/en/master.xml
___________________________________________________________________
Name: svn:keywords
- Author Date Id Revision
+ Id
Modified: trunk/HibernateExt/search/doc/reference/en/modules/configuration.xml
===================================================================
--- trunk/HibernateExt/search/doc/reference/en/modules/configuration.xml 2007-07-24
09:40:30 UTC (rev 12798)
+++ trunk/HibernateExt/search/doc/reference/en/modules/configuration.xml 2007-07-24
09:42:02 UTC (rev 12799)
@@ -1,14 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Id$ -->
<chapter id="search-configuration">
<title>Configuration</title>
<section id="search-configuration-directory" revision="1">
<title>Directory configuration</title>
- <para>Apache Lucene has a notion of Directory where the index is stored.
- The Directory implementation can be customized but Lucene comes bundled
- with a file system and a full memory implementation. Hibernate Search has
- the notion of <literal>DirectoryProvider</literal> that handle the
+ <para>Apache Lucene has a notion of Directory to store the index files.
+ The Directory implementation can be customized, but Lucene comes bundled
+ with a file system (<literal>FSDirectoryProvider</literal>) and a full
memory
+ (RAMDirectoryProvider) implementation. Hibernate Search has
+ the notion of <literal>DirectoryProvider</literal> that handles the
configuration and the initialization of the Lucene Directory.</para>
<table>
@@ -18,9 +20,9 @@
<thead>
<row>
<entry align="center">Class</entry>
+
+ <entry align="center">Description</entry>
- <entry align="center">description</entry>
-
<entry align="center">Properties</entry>
</row>
</thead>
@@ -171,9 +173,9 @@
<tbody>
<row>
- <entry>property</entry>
+ <entry>Property</entry>
- <entry>description</entry>
+ <entry>Description</entry>
</row>
<row>
@@ -428,4 +430,87 @@
</listitem>
</itemizedlist>
</section>
+
+ <section id="lucene-indexing-performance" revision="1">
+ <title>Tuning Lucene Indexing Performance</title>
+
+ <para>Hibernate Search allows you to tune the Lucene indexing performance by
specifying
+ a set of parameters which are passed through to underlying Lucene
+ <literal>IndexWriter</literal> as
<literal>mergeFactor</literal>, <literal>maxMergeDocs</literal>
+ and <literal>maxBufferedDocs</literal>. You can specify these paramters
either as default values
+ applying for all indeces or on a per index base.
+ </para>
+ <para>There are two sets of parameters
+ allowing for different performance settings depending on the use case. During
indexing operations
+ triggered by database modifications
+
<literal>hibernate.search.[default|<indexname>].merge_factor</literal>,
<literal>hibernate.search.[default|<indexname>].max_merge_docs</literal>
+ and
<literal>hibernate.search.[default|<indexname>].max_buffered_docs</literal>
are used. The corresponding
+ <literal>.batch</literal> properties are applied when indexing occurs via
+ <literal>FullTextSession.index()</literal> (see <xref
linkend="search-batchindex" />).
+ </para>
+ <para>
+ Unless the corresponding <literal>.batch</literal> property is set
explicitly it will have the
+ same value as the non batch parameter.
+ </para>
+ <para>
+ For more information about Lucene indexing performace please refer to the Lucene
documentation.
+ </para>
+
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry align="center">Property</entry>
+ <entry align="center">Description</entry>
+ <entry align="center">Default Value</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+
<entry><literal>hibernate.search.[default|<indexname>].merge_factor</literal></entry>
+ <entry>Controls segement merge frequency ans size. Used by Hibernate
Search during
+ index update operations as part of database modifications.
+ </entry>
+ <entry>10</entry>
+ </row>
+
+ <row>
+
<entry><literal>hibernate.search.[default|<indexname>].max_merge_docs</literal></entry>
+ <entry>Limits the number of documents per segment. Used by Hibernate
Search during
+ index update operations as part of database modifications.</entry>
+ <entry>Integer.MAX_VALUE</entry>
+ </row>
+
+ <row>
+
<entry><literal>hibernate.search.[default|<indexname>].max_buffered_docs</literal></entry>
+ <entry>Controls the amount of documents buffered during indexing. Used
by Hibernate
+ Search during index update operations as part of database modifications.
+ </entry>
+ <entry>10</entry>
+ </row>
+
+ <row>
+
<entry><literal>hibernate.search.[default|<indexname>].merge_factor.batch</literal></entry>
+ <entry>Controls segement merge frequency ans size.Used during indexing
via
+ <literal>FullTextSession.index()</literal></entry>
+ <entry>10</entry>
+ </row>
+
+ <row>
+
<entry><literal>hibernate.search.[default|<indexname>].max_merge_docs.batch</literal></entry>
+ <entry>Limits the number of documents per segment. Used during indexing
via
+ <literal>FullTextSession.index()</literal></entry>
+ <entry>Integer.MAX_VALUE</entry>
+ </row>
+
+ <row>
+
<entry><literal>hibernate.search.[default|<indexname>].max_buffered_docs.batch</literal></entry>
+ <entry>Controls the amount of documents buffered during indexing.Used
during indexing via
+ <literal>FullTextSession.index()</literal></entry>
+ <entry>10</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </section>
+
</chapter>
\ No newline at end of file
Property changes on: trunk/HibernateExt/search/doc/reference/en/modules/configuration.xml
___________________________________________________________________
Name: svn:keywords
- Author Date Id Revision
+ Id
Modified: trunk/HibernateExt/search/doc/reference/en/modules/lucene-native.xml
===================================================================
--- trunk/HibernateExt/search/doc/reference/en/modules/lucene-native.xml 2007-07-24
09:40:30 UTC (rev 12798)
+++ trunk/HibernateExt/search/doc/reference/en/modules/lucene-native.xml 2007-07-24
09:42:02 UTC (rev 12799)
@@ -1,4 +1,5 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Id$ -->
<chapter id="search-lucene-native">
<title>Accessing Lucene natively</title>
Property changes on: trunk/HibernateExt/search/doc/reference/en/modules/lucene-native.xml
___________________________________________________________________
Name: svn:keywords
+ Id
Modified: trunk/HibernateExt/search/doc/reference/en/modules/mapping.xml
===================================================================
--- trunk/HibernateExt/search/doc/reference/en/modules/mapping.xml 2007-07-24 09:40:30 UTC
(rev 12798)
+++ trunk/HibernateExt/search/doc/reference/en/modules/mapping.xml 2007-07-24 09:42:02 UTC
(rev 12799)
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Id$ -->
<chapter id="search-mapping" revision="3">
<title>Mapping entities to the index structure</title>
Property changes on: trunk/HibernateExt/search/doc/reference/en/modules/mapping.xml
___________________________________________________________________
Name: svn:keywords
- Author Date Id Revision
+ Id