com.hcl.domino.data

Enum CompactMode

java.lang.Object

java.lang.Enum<CompactMode>

com.hcl.domino.data.CompactMode

All Implemented Interfaces:

Serializable, Comparable<CompactMode>

public enum CompactMode
extends Enum<CompactMode>

Constants to configure the compaction operation

Since:

1.0.19

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARCHIVE Archive/delete, then compact the database
ARCHIVE_ONLY Just archive/delete, no need to compact
COMPRESS_DATA_DOCS TRUE if all data note non-summary should be compressed
COMPRESS_DESIGN_NS TRUE if design note non-summary should be compressed
COPY_REPLICA Create a new replica in the copy style compact
DISABLE_FORM_BKT_OPT Diable form/bucket bitmap optimization (default)
DISABLE_LARGE_UNKTBL Disable large UNK table in destination database (default)
DISABLE_RESPONSE_INFO Disable response info in resulting database
DISABLE_TXN_LOGGING If set, disable transaction logging for new database
DISABLE_UNREAD Disable unread marks in destination database
ENABLE_ENCRYPTION for copy style compaction, force "new" target to be encrypted even if source db is not
ENABLE_FORM_BKT_OPT Enable form/bucket bitmap optimization
ENABLE_LARGE_UNKTBL Enable large UNK table in destination database
ENABLE_RESPONSE_INFO Disable response info in resulting database (default)
ENABLE_TXN_LOGGING If set, enable transaction logging for new database
ENABLE_UNREAD Reenable unread marks in destination database (default)
FORCE_DAOS_OFF enable compact FROM DAOS
FORCE_DAOS_ON enable compact TO DAOS
FORCE_PIRC_OFF enable compact without PIRC
FORCE_PIRC_ON enable compact with PIRC
IGNORE_ERRORS Ignore errors encountered during compaction.
MAILBOX Compact XXXX.BOX for mail router and other MTAs
NO_INDEXES Don't preserve view indexes
NO_INPLACE Don't do in-place compaction
NO_LOCKOUT Don't lock out database users
RECOVER_ALL_SPACE If set, always do full space recovery compaction
RECOVER_SPACE_ONLY If set, do only bitmap correction if in-place can be done
REVERT_ODS Revert current ODS to the previous ODS version
SPLIT_NIF_DATA split NIF containers out to their own database
UNCOMPRESS_DATA_DOCS TRUE if all data note non-summary should be uncompressed
UNCOMPRESS_DESIGN_NS TRUE if design note non-summary should be uncompressed
UNSPLIT_NIF_DATA see above, but off

Method Summary

Modifier and Type	Method and Description
int	getSetIndex()
int	getValue()
static CompactMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompactMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_INDEXES

public static final CompactMode NO_INDEXES

Don't preserve view indexes

NO_LOCKOUT

public static final CompactMode NO_LOCKOUT

Don't lock out database users

REVERT_ODS

public static final CompactMode REVERT_ODS

Revert current ODS to the previous ODS version

MAILBOX

public static final CompactMode MAILBOX

Compact XXXX.BOX for mail router and other MTAs

NO_INPLACE

public static final CompactMode NO_INPLACE

Don't do in-place compaction

DISABLE_UNREAD

public static final CompactMode DISABLE_UNREAD

Disable unread marks in destination database

ENABLE_UNREAD

public static final CompactMode ENABLE_UNREAD

Reenable unread marks in destination database (default)

DISABLE_RESPONSE_INFO

public static final CompactMode DISABLE_RESPONSE_INFO

Disable response info in resulting database

ENABLE_RESPONSE_INFO

public static final CompactMode ENABLE_RESPONSE_INFO

Disable response info in resulting database (default)

ENABLE_FORM_BKT_OPT

public static final CompactMode ENABLE_FORM_BKT_OPT

Enable form/bucket bitmap optimization

DISABLE_FORM_BKT_OPT

public static final CompactMode DISABLE_FORM_BKT_OPT

Diable form/bucket bitmap optimization (default)

IGNORE_ERRORS

public static final CompactMode IGNORE_ERRORS

Ignore errors encountered during compaction. That is, make best effort to get something at the end

DISABLE_TXN_LOGGING

public static final CompactMode DISABLE_TXN_LOGGING

If set, disable transaction logging for new database

ENABLE_TXN_LOGGING

public static final CompactMode ENABLE_TXN_LOGGING

If set, enable transaction logging for new database

RECOVER_SPACE_ONLY

public static final CompactMode RECOVER_SPACE_ONLY

If set, do only bitmap correction if in-place can be done

ARCHIVE

public static final CompactMode ARCHIVE

Archive/delete, then compact the database

ARCHIVE_ONLY

public static final CompactMode ARCHIVE_ONLY

Just archive/delete, no need to compact

RECOVER_ALL_SPACE

public static final CompactMode RECOVER_ALL_SPACE

If set, always do full space recovery compaction

DISABLE_LARGE_UNKTBL

public static final CompactMode DISABLE_LARGE_UNKTBL

Disable large UNK table in destination database (default)

ENABLE_LARGE_UNKTBL

public static final CompactMode ENABLE_LARGE_UNKTBL

Enable large UNK table in destination database

COMPRESS_DESIGN_NS

public static final CompactMode COMPRESS_DESIGN_NS

TRUE if design note non-summary should be compressed

UNCOMPRESS_DESIGN_NS

public static final CompactMode UNCOMPRESS_DESIGN_NS

TRUE if design note non-summary should be uncompressed

COMPRESS_DATA_DOCS

public static final CompactMode COMPRESS_DATA_DOCS

TRUE if all data note non-summary should be compressed

UNCOMPRESS_DATA_DOCS

public static final CompactMode UNCOMPRESS_DATA_DOCS

TRUE if all data note non-summary should be uncompressed

FORCE_DAOS_ON

public static final CompactMode FORCE_DAOS_ON

enable compact TO DAOS

FORCE_DAOS_OFF

public static final CompactMode FORCE_DAOS_OFF

enable compact FROM DAOS

SPLIT_NIF_DATA

public static final CompactMode SPLIT_NIF_DATA

split NIF containers out to their own database

UNSPLIT_NIF_DATA

public static final CompactMode UNSPLIT_NIF_DATA

see above, but off

FORCE_PIRC_ON

public static final CompactMode FORCE_PIRC_ON

enable compact with PIRC

FORCE_PIRC_OFF

public static final CompactMode FORCE_PIRC_OFF

enable compact without PIRC

ENABLE_ENCRYPTION

public static final CompactMode ENABLE_ENCRYPTION

for copy style compaction, force "new" target to be encrypted even if source db is not

COPY_REPLICA

public static final CompactMode COPY_REPLICA

Create a new replica in the copy style compact

Method Detail

values

public static CompactMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CompactMode c : CompactMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CompactMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getSetIndex

public int getSetIndex()

getValue

public int getValue()