[hibernate-commits] Hibernate SVN: r19891 - core/trunk/documentation/envers/src/main/docbook/en-US/content.

[hibernate-commits at lists.jboss.org]

Author: adamw
Date: 2010-07-02 08:57:18 -0400 (Fri, 02 Jul 2010)
New Revision: 19891

Modified:
   core/trunk/documentation/envers/src/main/docbook/en-US/content/configuration.xml
   core/trunk/documentation/envers/src/main/docbook/en-US/content/queries.xml
Log:
HHH-3764, HHH-3765:
documentation

Modified: core/trunk/documentation/envers/src/main/docbook/en-US/content/configuration.xml
===================================================================
--- core/trunk/documentation/envers/src/main/docbook/en-US/content/configuration.xml	2010-07-02 08:54:15 UTC (rev 19890)
+++ core/trunk/documentation/envers/src/main/docbook/en-US/content/configuration.xml	2010-07-02 12:57:18 UTC (rev 19891)
@@ -177,6 +177,32 @@
                         be the same as the catalog of the normal tables.                        
                     </entry>
                 </row>
+                <row>
+                    <entry>
+                        <property>org.hibernate.envers.audit_strategy</property>
+                    </entry>
+                    <entry>
+                        org.hibernate.envers.strategy.DefaultAuditStrategy
+                    </entry>
+                    <entry>
+                        The audit strategy that should be used when persisting audit data. The default stores only the
+                        revision, at which an entity was modified. An alternative,
+                        <literal>org.hibernate.envers.strategy.ValidTimeAuditStrategy</literal> stores additionaly the
+                        end revision, until which the data was valid.
+                    </entry>
+                </row>
+                <row>
+                    <entry>
+                        <property>org.hibernate.envers.audit_strategy_valid_time_end_name</property>
+                    </entry>
+                    <entry>
+                        REVEND
+                    </entry>
+                    <entry>
+                        Only valid if the audit strategy is valid-time. Name of the column that will hold the end
+                        revision number in audit entities.
+                    </entry>
+                </row>
             </tbody>
         </tgroup>
     </table>

Modified: core/trunk/documentation/envers/src/main/docbook/en-US/content/queries.xml
===================================================================
--- core/trunk/documentation/envers/src/main/docbook/en-US/content/queries.xml	2010-07-02 08:54:15 UTC (rev 19890)
+++ core/trunk/documentation/envers/src/main/docbook/en-US/content/queries.xml	2010-07-02 12:57:18 UTC (rev 19891)
@@ -58,6 +58,12 @@
         than corresponding queries on "live" data, as they involve correlated subselects.
     </para>
 
+    <para>
+        In the future, queries will be improved both in terms of speed and possibilities, when using the valid-time
+        audit strategy, that is when storing both start and end revisions for entities. See
+        <xref linkend="configuration"/>.
+    </para>
+
     <section id="entities-at-revision">
 
         <title>Querying for entities of a class at a given revision</title>