1:42 p.m.
Author: clebert.suconic(a)jboss.com
Date: 2010-08-13 14:42:27 -0400 (Fri, 13 Aug 2010)
New Revision: 9547
Modified:
trunk/docs/user-manual/en/persistence.xml
trunk/src/main/org/hornetq/core/journal/impl/ExportJournal.java
trunk/src/main/org/hornetq/core/journal/impl/ImportJournal.java
Log:
HORNETQ-180 - Import/Export tool documentation
Modified: trunk/docs/user-manual/en/persistence.xml
===================================================================
--- trunk/docs/user-manual/en/persistence.xml 2010-08-13 15:55:27 UTC (rev 9546)
+++ trunk/docs/user-manual/en/persistence.xml 2010-08-13 18:42:27 UTC (rev 9547)
@@ -67,14 +67,16 @@
<para>The AIO journal is only available when running Linux kernel 2.6
or later and after
having installed libaio (if it's not already installed). For
instructions on how to
install libaio please see <xref
linkend="installing-aio"/>.</para>
- <para>Also, please note that AIO will only work with the following file
systems: ext2, ext3, ext4, jfs, xfs. With other file systems,
- e.g. NFS it may appear to work, but it will fall back to a slower sychronous
behaviour. Don't put the journal on a NFS share!</para>
+ <para>Also, please note that AIO will only work with the following file
systems: ext2,
+ ext3, ext4, jfs, xfs. With other file systems, e.g. NFS it may appear to
work, but
+ it will fall back to a slower sychronous behaviour. Don't put the
journal on a NFS
+ share!</para>
<para>For more information on libaio please see <xref
linkend="libaio"/>.</para>
<para>libaio is part of the kernel project.</para>
</listitem>
</itemizedlist>
<para>The standard HornetQ core server uses two instances of the
journal:</para>
- <itemizedlist>
+ <itemizedlist id="persistence.journallist">
<listitem>
<para>Bindings journal.</para>
<para>This journal is used to store bindings related data. That
includes the set of
@@ -82,13 +84,21 @@
such as id sequence counters. </para>
<para>The bindings journal is always a NIO journal as it is typically
low throughput
compared to the message journal.</para>
+ <para>The files on this journal are prefixed as
<literal>hornetq-bindings</literal>.
+ Each file has a <literal>bindings</literal> extension. File
size is <literal
+ >1048576</literal>, and it is located at the bindings
folder.</para>
</listitem>
- <listitem>
+ <listitem>
<para>JMS journal.</para>
- <para>This journal instance stores all JMS related data, This is
basically any JMS Queues, Topics and Connection
- Factories and any JNDI bindings for these resources.</para>
- <para>Any JMS Resources created via the management API will be
persisted to this journal. Any resources
- configured via configuration files will not. The JMS Journal will only be
created if JMS is being used.</para>
+ <para>This journal instance stores all JMS related data, This is
basically any JMS
+ Queues, Topics and Connection Factories and any JNDI bindings for these
+ resources.</para>
+ <para>Any JMS Resources created via the management API will be
persisted to this
+ journal. Any resources configured via configuration files will not. The
JMS Journal
+ will only be created if JMS is being used.</para>
+ <para>The files on this journal are prefixed as
<literal>hornetq-jms</literal>. Each
+ file has a <literal>jms</literal> extension. File size is
<literal
+ >1048576</literal>, and it is located at the bindings
folder.</para>
</listitem>
<listitem>
<para>Message journal.</para>
@@ -98,6 +108,10 @@
the platform is not Linux with the correct kernel version or AIO has not
been
installed then it will automatically fall back to using Java NIO which is
available
on any Java platform.</para>
+ <para>The files on this journal are prefixed as
<literal>hornetq-data</literal>. Each
+ file has a <literal>hq</literal> extension. File size is by
the default <literal
+ >10485760</literal> (configurable), and it is located at the
journal
+ folder.</para>
</listitem>
</itemizedlist>
<para>For large messages, HornetQ persists them outside the message journal.
This is discussed
@@ -125,7 +139,7 @@
</listitem>
</itemizedlist>
</section>
- <section id="configuring.bindings.jms">
+ <section id="configuring.bindings.jms">
<title>Configuring the jms journal</title>
<para>The jms config shares its configuration with the bindings
journal.</para>
</section>
@@ -299,4 +313,40 @@
persistence will occur. That means no bindings data, message data, large
message data,
duplicate id caches or paging data will be persisted.</para>
</section>
+ <section id="persistence.importexport">
+ <title>Import/Export the Journal Data</title>
+ <para>You may want to inspect the existent records on each one of the
journals used by
+ HornetQ, and you can use the export/import tool for that purpose. The
export/import are
+ classes located at the hornetq-core.jar, you can export the journal as a text
file by
+ using this command:</para>
+ <para><literal>java -cp hornetq-core.jar
org.hornetq.core.journal.impl.ExportJournal
+ <JournalDirectory> <JournalPrefix>
<FileExtension> <FileSize>
+ <FileOutput></literal></para>
+ <para>To import the file as binary data on the journal (Notice you also
require
+ netty.jar):</para>
+ <para><literal>java -cp hornetq-core.jar:netty.jar
org.hornetq.core.journal.impl.ImportJournal
+ <JournalDirectory> <JournalPrefix>
<FileExtension> <FileSize>
+ <FileInput></literal></para>
+ <itemizedlist>
+ <listitem>
+ <para>JournalDirectory: Use the configured folder for your selected
folder. Example:
+ ./hornetq/data/journal</para>
+ </listitem>
+ <listitem>
+ <para>JournalPrefix: Use the prefix for your selected journal, as
discussed
+ <link
linkend="persistence.journallist">here</link></para>
+ </listitem>
+ <listitem>
+ <para>FileExtension: Use the extension for your selected journal,
as discussed
+ <link
linkend="persistence.journallist">here</link></para>
+ </listitem>
+ <listitem>
+ <para>FileSize: Use the size for your selected journal, as
discussed <link
+
linkend="persistence.journallist">here</link></para>
+ </listitem>
+ <listitem>
+ <para>FileOutput: text file that will contain the exported
data</para>
+ </listitem>
+ </itemizedlist>
+ </section>
</chapter>
Modified: trunk/src/main/org/hornetq/core/journal/impl/ExportJournal.java
===================================================================
--- trunk/src/main/org/hornetq/core/journal/impl/ExportJournal.java 2010-08-13 15:55:27
UTC (rev 9546)
+++ trunk/src/main/org/hornetq/core/journal/impl/ExportJournal.java 2010-08-13 18:42:27
UTC (rev 9547)
@@ -50,15 +50,15 @@
public static void main(String arg[])
{
- if (arg.length != 6)
+ if (arg.length != 5)
{
- System.err.println("Use: java -cp hornetq-core.jar
org.hornetq.core.journal.impl.ExportJournal <JournalDirectory> <JournalPrefix>
<FileExtension> <MinFiles> <FileSize> <FileOutput>");
+ System.err.println("Use: java -cp hornetq-core.jar
org.hornetq.core.journal.impl.ExportJournal <JournalDirectory> <JournalPrefix>
<FileExtension> <FileSize> <FileOutput>");
return;
}
try
{
- exportJournal(arg[0], arg[1], arg[2], Integer.parseInt(arg[3]),
Integer.parseInt(arg[4]), arg[5]);
+ exportJournal(arg[0], arg[1], arg[2], 2, Integer.parseInt(arg[3]), arg[4]);
}
catch (Exception e)
{
Modified: trunk/src/main/org/hornetq/core/journal/impl/ImportJournal.java
===================================================================
--- trunk/src/main/org/hornetq/core/journal/impl/ImportJournal.java 2010-08-13 15:55:27
UTC (rev 9546)
+++ trunk/src/main/org/hornetq/core/journal/impl/ImportJournal.java 2010-08-13 18:42:27
UTC (rev 9547)
@@ -54,15 +54,15 @@
public static void main(String arg[])
{
- if (arg.length != 6)
+ if (arg.length != 5)
{
- System.err.println("Use: java -cp hornetq-core.jar
org.hornetq.core.journal.impl.ImportJournal <JournalDirectory> <JournalPrefix>
<FileExtension> <MinFiles> <FileSize> <FileOutput>");
+ System.err.println("Use: java -cp hornetq-core.jar:netty.jar
org.hornetq.core.journal.impl.ImportJournal <JournalDirectory> <JournalPrefix>
<FileExtension> <FileSize> <FileOutput>");
return;
}
try
{
- importJournal(arg[0], arg[1], arg[2], Integer.parseInt(arg[3]),
Integer.parseInt(arg[4]), arg[5]);
+ importJournal(arg[0], arg[1], arg[2], 2, Integer.parseInt(arg[3]), arg[4]);
}
catch (Exception e)
{