com.bigdata.resources

Interface IndexManager.Options

All Superinterfaces:

Options, StoreManager.Options

All Known Subinterfaces:

DataService.Options, EmbeddedClient.Options, MetadataService.Options, OverflowManager.Options, ResourceManager.Options, StressTestConcurrent.TestOptions

Enclosing class:

IndexManager

public static interface IndexManager.Options
extends StoreManager.Options

Options understood by the IndexManager.

Author:

Bryan Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_INDEX_CACHE_CAPACITY
static String	DEFAULT_INDEX_CACHE_TIMEOUT
static String	DEFAULT_INDEX_SEGMENT_CACHE_CAPACITY The default for the INDEX_SEGMENT_CACHE_CAPACITY option.
static String	DEFAULT_INDEX_SEGMENT_CACHE_TIMEOUT
static String	INDEX_CACHE_CAPACITY The capacity of the LRU cache of open IIndexs.
static String	INDEX_CACHE_TIMEOUT The time in milliseconds before an entry in the index cache will be cleared from the backing HardReferenceQueue (default "60000").
static String	INDEX_SEGMENT_CACHE_CAPACITY The capacity of the LRU cache of open IndexSegments.
static String	INDEX_SEGMENT_CACHE_TIMEOUT The time in milliseconds before an entry in the index segment cache will be cleared from the backing HardReferenceQueue (default "60000").

Fields inherited from interface com.bigdata.resources.StoreManager.Options

ACCELERATE_OVERFLOW_THRESHOLD, DATA_DIR, DEFAULT_ACCELERATE_OVERFLOW_THRESHOLD, DEFAULT_IGNORE_BAD_FILES, DEFAULT_PURGE_OLD_RESOURCES_DURING_STARTUP, DEFAULT_STORE_CACHE_CAPACITY, DEFAULT_STORE_CACHE_TIMEOUT, IGNORE_BAD_FILES, PURGE_OLD_RESOURCES_DURING_STARTUP, STORE_CACHE_CAPACITY, STORE_CACHE_TIMEOUT

Fields inherited from interface com.bigdata.journal.Options

ALTERNATE_ROOT_BLOCK, BUFFER_MODE, CREATE, CREATE_TEMP_FILE, CREATE_TIME, DEFAULT_BUFFER_MODE, DEFAULT_CREATE, DEFAULT_CREATE_TEMP_FILE, DEFAULT_DELETE_ON_CLOSE, DEFAULT_DELETE_ON_EXIT, DEFAULT_DOUBLE_SYNC, DEFAULT_FILE_LOCK_ENABLED, DEFAULT_FORCE_ON_COMMIT, DEFAULT_FORCE_WRITES, DEFAULT_HALOG_COMPRESSOR, DEFAULT_HISTORICAL_INDEX_CACHE_CAPACITY, DEFAULT_HISTORICAL_INDEX_CACHE_TIMEOUT, DEFAULT_HOT_CACHE_SIZE, DEFAULT_HOT_CACHE_THRESHOLD, DEFAULT_INITIAL_EXTENT, DEFAULT_LIVE_INDEX_CACHE_CAPACITY, DEFAULT_LIVE_INDEX_CACHE_TIMEOUT, DEFAULT_MAXIMUM_EXTENT, DEFAULT_MINIMUM_EXTENSION, DEFAULT_READ_CACHE_BUFFER_COUNT, DEFAULT_READ_ONLY, DEFAULT_USE_DIRECT_BUFFERS, DEFAULT_VALIDATE_CHECKSUM, DEFAULT_WRITE_CACHE_BUFFER_COUNT, DEFAULT_WRITE_CACHE_COMPACTION_THRESHOLD, DEFAULT_WRITE_CACHE_ENABLED, DEFAULT_WRITE_CACHE_MIN_CLEAN_LIST_SIZE, DELETE_ON_CLOSE, DELETE_ON_EXIT, DOUBLE_SYNC, FILE, FILE_LOCK_ENABLED, FORCE_ON_COMMIT, FORCE_WRITES, HALOG_COMPRESSOR, HISTORICAL_INDEX_CACHE_CAPACITY, HISTORICAL_INDEX_CACHE_TIMEOUT, HOT_CACHE_SIZE, HOT_CACHE_THRESHOLD, IGNORE_BAD_ROOT_BLOCK, INITIAL_EXTENT, JNL, LIVE_INDEX_CACHE_CAPACITY, LIVE_INDEX_CACHE_TIMEOUT, MAXIMUM_EXTENT, MEM_MAX_EXTENT, MINIMUM_EXTENSION, minimumInitialExtent, minimumMinimumExtension, OFFSET_BITS, OTHER_MAX_EXTENT, READ_CACHE_BUFFER_COUNT, READ_ONLY, RW_MAX_EXTENT, SEG, TMP_DIR, UPDATE_ICU_VERSION, USE_DIRECT_BUFFERS, VALIDATE_CHECKSUM, WRITE_CACHE_BUFFER_COUNT, WRITE_CACHE_COMPACTION_THRESHOLD, WRITE_CACHE_ENABLED, WRITE_CACHE_MIN_CLEAN_LIST_SIZE

Field Detail

INDEX_CACHE_CAPACITY

static final String INDEX_CACHE_CAPACITY

The capacity of the LRU cache of open IIndexs. The capacity of this cache indirectly controls how many IIndexs will be held open. The main reason for keeping an IIndex open is to reuse its buffers, including its node and leaf cache, if another request arrives "soon" which would require on that IIndex.

The effect of this parameter is indirect owning to the semantics of weak references and the control of the JVM over when they are cleared. Once an index becomes weakly reachable, the JVM will eventually GC the index object, thereby effectively closing it (or at least releasing all resources associated with that index). Since indices which are strongly reachable are never "closed" this provides our guarantee that indices are never closed if they are in use.

Note: The IIndexs managed by this class are a FusedView of AbstractBTrees. Each AbstractBTree has a hard reference to the backing IRawStore and will keep the IRawStore from being finalized as long as a hard reference exists to the AbstractBTree (the reverse is not true - an IRawStore reference does NOT hold a hard reference to AbstractBTrees on that IRawStore).

Note: The retention of the BTrees on the live ManagedJournals is governed by Options.LIVE_INDEX_CACHE_CAPACITY.

Note: The retention of the BTrees on the open historical ManagedJournals is governed by Options.HISTORICAL_INDEX_CACHE_CAPACITY.

See Also:

DEFAULT_INDEX_CACHE_CAPACITY

DEFAULT_INDEX_CACHE_CAPACITY

static final String DEFAULT_INDEX_CACHE_CAPACITY

See Also:

Constant Field Values

INDEX_CACHE_TIMEOUT

static final String INDEX_CACHE_TIMEOUT

The time in milliseconds before an entry in the index cache will be cleared from the backing HardReferenceQueue (default "60000"). This property controls how long the index cache will retain an IIndex which has not been recently used. This is in contrast to the cache capacity.

DEFAULT_INDEX_CACHE_TIMEOUT

static final String DEFAULT_INDEX_CACHE_TIMEOUT

See Also:

Constant Field Values

INDEX_SEGMENT_CACHE_CAPACITY

static final String INDEX_SEGMENT_CACHE_CAPACITY

The capacity of the LRU cache of open IndexSegments. The capacity of this cache indirectly controls how many IndexSegments will be held open. The main reason for keeping an IndexSegment open is to reuse its buffers, including its node and leaf cache, if another request arrives "soon" which would read on that IndexSegment.

The effect of this parameter is indirect owning to the semantics of weak references and the control of the JVM over when they are cleared. Once an index becomes weakly reachable, the JVM will eventually GC the index object, thereby effectively closing it (or at least releasing all resources associated with that index). Since indices which are strongly reachable are never "closed" this provides our guarantee that indices are never closed if they are in use.

Note: IndexSegments have a hard reference to the backing IndexSegmentStore and will keep the IndexSegmentStore from being finalized as long as a hard reference exists to the IndexSegment (the reverse is not true - the IndexSegmentStore does NOT hold a hard reference to the IndexSegment).

See Also:

DEFAULT_INDEX_SEGMENT_CACHE_CAPACITY

DEFAULT_INDEX_SEGMENT_CACHE_CAPACITY

static final String DEFAULT_INDEX_SEGMENT_CACHE_CAPACITY

The default for the INDEX_SEGMENT_CACHE_CAPACITY option.

See Also:

Constant Field Values

INDEX_SEGMENT_CACHE_TIMEOUT

static final String INDEX_SEGMENT_CACHE_TIMEOUT

The time in milliseconds before an entry in the index segment cache will be cleared from the backing HardReferenceQueue (default "60000"). This property controls how long the index segment cache will retain an IndexSegment which has not been recently used. This is in contrast to the cache capacity.

DEFAULT_INDEX_SEGMENT_CACHE_TIMEOUT

static final String DEFAULT_INDEX_SEGMENT_CACHE_TIMEOUT

See Also:

Constant Field Values