org.modeshape.jcr.api

Class BackupOptions

java.lang.Object

org.modeshape.jcr.api.BackupOptions

public abstract class BackupOptions
extends Object

Class which allows a customization of the backup process.

Field Summary

Fields

Modifier and Type	Field and Description
static BackupOptions	DEFAULT Default backup options which will be used when a backup is performed without an explicit set of options.
static int	DEFAULT_BATCH_SIZE The number of documents read form the persistent store and written in a backup file in one unit
static long	DEFAULT_DOCUMENTS_PER_FILE By default, 100K nodes will be exported to a single backup file.

Constructor Summary

Constructors

Constructor and Description
BackupOptions()

Method Summary

Modifier and Type	Method and Description
int	batchSize() Return the number of documents that should be read and written to the backup file in one unit.
boolean	compress() Return whether or not each backup file (which contains multiple documents) should be compressed or not.
long	documentsPerFile() Return the number of documents which should be backed up in a single file.
boolean	includeBinaries() Whether or not binary data should be part of the backup or not.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DOCUMENTS_PER_FILE

public static final long DEFAULT_DOCUMENTS_PER_FILE

By default, 100K nodes will be exported to a single backup file. So, if each node requires about 200 bytes (compressed), the resulting files will be about 19 MB in size.

See Also:

Constant Field Values

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

The number of documents read form the persistent store and written in a backup file in one unit

See Also:

Constant Field Values

DEFAULT

public static final BackupOptions DEFAULT

Default backup options which will be used when a backup is performed without an explicit set of options.

Constructor Detail

BackupOptions

public BackupOptions()

Method Detail

includeBinaries

public boolean includeBinaries()

Whether or not binary data should be part of the backup or not. Since ModeShape stores references from the schematic documents toward the binary values which are being used, it might not always be desired to do a full binary backup.

Returns:

true if binary data should be exported; defaults to true

documentsPerFile

public long documentsPerFile()

Return the number of documents which should be backed up in a single file.

Returns:

the number documents; defaults to

batchSize

public int batchSize()

Return the number of documents that should be read and written to the backup file in one unit.

This is a setting that can be used to influence the memory and throughout of the backup process.

Returns:

the number of documents; defaults to 10000

Since:

5.0

compress

public boolean compress()

Return whether or not each backup file (which contains multiple documents) should be compressed or not.

Returns:

true if the backup files should be compressed; defaults to true

toString

public String toString()

Overrides:

toString in class Object