com.bigdata.journal

Class DumpJournal

java.lang.Object

com.bigdata.journal.DumpJournal

public class DumpJournal
extends Object

A utility class that opens the journal in a read-only mode and dumps the root blocks and metadata about the indices on a journal file. TODO add an option to dump only as of a specified commitTime? TODO GIST : Support all types of indices.

Author:

Bryan Thompson

See Also:

GIST

Constructor Summary

Constructors

Constructor and Description
DumpJournal(Journal journal)

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpJournal(boolean dumpHistory, boolean dumpPages, boolean dumpIndices, boolean showTuples)
void	dumpJournal(PrintWriter out, List<String> namespaces, boolean dumpHistory, boolean dumpPages, boolean dumpIndices, boolean showTuples)
static void	main(String[] args) Dump one or more journal files:

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DumpJournal

public DumpJournal(Journal journal)

Method Detail

main

public static void main(String[] args)

Dump one or more journal files:

 usage: (option*) filename+
 

where option is any of:

-namespace

Dump only those indices having the specified namespace prefix.

-history

Dump metadata for indices in all commit records (default only dumps the metadata for the indices as of the most current committed state).

-indices

Dump the indices (does not show the tuples by default).

-pages

Dump the pages of the indices and reports some information on the page size.

-tuples

Dump the records in the indices.

where filename is one or more journal file names.

dumpJournal

public void dumpJournal(boolean dumpHistory,
               boolean dumpPages,
               boolean dumpIndices,
               boolean showTuples)

Parameters:

dumpHistory - Dump metadata for indices in all commit records (default only dumps the metadata for the indices as of the most current committed state).

dumpPages - Dump the pages of the indices and reports some information on the page size.

dumpIndices - Dump the indices (does not show the tuples by default).

showTuples - Dump the records in the indices.

dumpJournal

public void dumpJournal(PrintWriter out,
               List<String> namespaces,
               boolean dumpHistory,
               boolean dumpPages,
               boolean dumpIndices,
               boolean showTuples)

Parameters:

out - Where to write the output.

namespaces - When non-empty and non-null, dump only those indices having any of the specified namespaces.

dumpHistory - Dump metadata for indices in all commit records (default only dumps the metadata for the indices as of the most current committed state).

dumpPages - Dump the pages of the indices and reports some information on the page size.

dumpIndices - Dump the indices (does not show the tuples by default).

showTuples - Dump the records in the indices.