PersistentStoreConfiguration (Ignite 2.1.0)

java.lang.Object
- org.apache.ignite.configuration.PersistentStoreConfiguration

All Implemented Interfaces:

Serializable
```
public class PersistentStoreConfiguration
extends Object
implements Serializable
```
Configures Apache Ignite Persistent store.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DFLT_CHECKPOINTING_FREQ`
`static int`	`DFLT_CHECKPOINTING_THREADS` Default number of checkpointing threads.
`static int`	`DFLT_LOCK_WAIT_TIME` Lock default wait time, 10 sec.
`static boolean`	`DFLT_METRICS_ENABLED`
`static int`	`DFLT_RATE_TIME_INTERVAL_MILLIS` Default length of interval over which rate-based metric is calculated.
`static int`	`DFLT_SUB_INTERVALS` Default amount of sub intervals to calculate rate-based metric.
`static int`	`DFLT_TLB_SIZE` Default thread local buffer size.
`static boolean`	`DFLT_WAL_ALWAYS_WRITE_FULL_PAGES` Default wal always write full pages.
`static String`	`DFLT_WAL_ARCHIVE_PATH` Default wal archive directory.
`static int`	`DFLT_WAL_FLUSH_FREQ` Default Wal flush frequency.
`static int`	`DFLT_WAL_FSYNC_DELAY` Default wal fsync delay.
`static int`	`DFLT_WAL_HISTORY_SIZE` Default number of checkpoints to be kept in WAL after checkpoint is finished
`static WALMode`	`DFLT_WAL_MODE` Default wal mode.
`static int`	`DFLT_WAL_RECORD_ITERATOR_BUFFER_SIZE` Default wal record iterator buffer size.
`static int`	`DFLT_WAL_SEGMENT_SIZE` Default WAL file segment size, 64MBytes
`static int`	`DFLT_WAL_SEGMENTS`
`static String`	`DFLT_WAL_STORE_PATH` Default wal directory.

Constructor Summary

Constructors
Constructor and Description

PersistentStoreConfiguration()

Constructors
Constructor and Description
`PersistentStoreConfiguration()`

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`getCheckpointingFrequency()` Gets checkpointing frequency.
`long`	`getCheckpointingPageBufferSize()` Gets amount of memory allocated for a checkpointing temporary buffer.
`int`	`getCheckpointingThreads()` Gets a number of threads to use for the checkpointing purposes.
`FileIOFactory`	`getFileIOFactory()` Factory to provide implementation of FileIO interface which is used for any file read/write operations
`long`	`getLockWaitTime()` Time out in milliseonds to wait when acquiring persistence store lock file before failing the local node.
`String`	`getPersistentStorePath()` Returns a path the root directory where the Persistent Store will persist data and indexes.
`long`	`getRateTimeInterval()` Gets the length of the time interval for rate-based metrics.
`int`	`getSubIntervals()` Gets the number of sub-intervals to split the `getRateTimeInterval()` into to track the update history.
`int`	`getTlbSize()` Property define size thread local buffer.
`String`	`getWalArchivePath()` Gets a path to the WAL archive directory.
`long`	`getWalAutoArchiveAfterInactivity()`
`long`	`getWalFlushFrequency()` This property define how often WAL will be fsync-ed in `BACKGROUND` mode.
`long`	`getWalFsyncDelayNanos()` Gets the fsync delay, in nanoseconds.
`int`	`getWalHistorySize()` Gets a total number of checkpoints to keep in the WAL history.
`WALMode`	`getWalMode()` Type define behavior wal fsync.
`int`	`getWalRecordIteratorBufferSize()` Property define how many bytes iterator read from disk (for one reading), during go ahead wal.
`int`	`getWalSegments()` Gets a number of WAL segments to work with.
`int`	`getWalSegmentSize()` Gets size of a WAL segment in bytes.
`String`	`getWalStorePath()` Gets a path to the directory where WAL is stored.
`boolean`	`isAlwaysWriteFullPages()`
`boolean`	`isMetricsEnabled()` Gets flag indicating whether persistence metrics collection is enabled.
`PersistentStoreConfiguration`	`setAlwaysWriteFullPages(boolean alwaysWriteFullPages)`
`PersistentStoreConfiguration`	`setCheckpointingFrequency(long checkpointingFreq)` Sets the checkpointing frequency which is a minimal interval when the dirty pages will be written to the Persistent Store.
`PersistentStoreConfiguration`	`setCheckpointingPageBufferSize(long checkpointingPageBufSize)` Sets amount of memory allocated for the checkpointing temporary buffer.
`PersistentStoreConfiguration`	`setCheckpointingThreads(int checkpointingThreads)` Sets a number of threads to use for the checkpointing purposes.
`PersistentStoreConfiguration`	`setFileIOFactory(FileIOFactory fileIOFactory)`
`PersistentStoreConfiguration`	`setLockWaitTime(long lockWaitTime)` Time out in milliseconds to wait when acquiring persistence store lock file before failing the local node.
`PersistentStoreConfiguration`	`setMetricsEnabled(boolean metricsEnabled)` Sets flag indicating whether persistence metrics collection is enabled.
`PersistentStoreConfiguration`	`setPersistentStorePath(String persistenceStorePath)` Sets a path to the root directory where the Persistent Store will persist data and indexes.
`PersistentStoreConfiguration`	`setRateTimeInterval(long rateTimeInterval)` Sets the length of the time interval for rate-based metrics.
`PersistentStoreConfiguration`	`setSubIntervals(int subIntervals)` Sets the number of sub-intervals to split the `getRateTimeInterval()` into to track the update history.
`PersistentStoreConfiguration`	`setTlbSize(int tlbSize)`
`PersistentStoreConfiguration`	`setWalArchivePath(String walArchivePath)` Sets a path for the WAL archive directory.
`PersistentStoreConfiguration`	`setWalAutoArchiveAfterInactivity(long walAutoArchiveAfterInactivity)` Note: setting this value with `WALMode.DEFAULT` may generate file size overhead for WAL segments in case grid is used rarely.
`PersistentStoreConfiguration`	`setWalFlushFrequency(long walFlushFreq)` This property define how often WAL will be fsync-ed in `BACKGROUND` mode.
`PersistentStoreConfiguration`	`setWalFsyncDelayNanos(long walFsyncDelayNanos)`
`PersistentStoreConfiguration`	`setWalHistorySize(int walHistSize)` Sets a total number of checkpoints to keep in the WAL history.
`PersistentStoreConfiguration`	`setWalMode(WALMode walMode)`
`PersistentStoreConfiguration`	`setWalRecordIteratorBufferSize(int walRecordIterBuffSize)`
`PersistentStoreConfiguration`	`setWalSegments(int walSegments)` Sets a number of WAL segments to work with.
`PersistentStoreConfiguration`	`setWalSegmentSize(int walSegmentSize)` Sets size of a WAL segment.
`PersistentStoreConfiguration`	`setWalStorePath(String walStorePath)` Sets a path to the directory where WAL is stored .
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DFLT_CHECKPOINTING_FREQ
```
public static final int DFLT_CHECKPOINTING_FREQ
```
    See Also:
    Constant Field Values
  - DFLT_LOCK_WAIT_TIME
```
public static final int DFLT_LOCK_WAIT_TIME
```
    Lock default wait time, 10 sec.
    
    See Also:
    Constant Field Values
  - DFLT_METRICS_ENABLED
```
public static final boolean DFLT_METRICS_ENABLED
```
    See Also:
    Constant Field Values
  - DFLT_SUB_INTERVALS
```
public static final int DFLT_SUB_INTERVALS
```
    Default amount of sub intervals to calculate rate-based metric.
    
    See Also:
    Constant Field Values
  - DFLT_RATE_TIME_INTERVAL_MILLIS
```
public static final int DFLT_RATE_TIME_INTERVAL_MILLIS
```
    Default length of interval over which rate-based metric is calculated.
    
    See Also:
    Constant Field Values
  - DFLT_CHECKPOINTING_THREADS
```
public static final int DFLT_CHECKPOINTING_THREADS
```
    Default number of checkpointing threads.
    
    See Also:
    Constant Field Values
  - DFLT_WAL_HISTORY_SIZE
```
public static final int DFLT_WAL_HISTORY_SIZE
```
    Default number of checkpoints to be kept in WAL after checkpoint is finished
    
    See Also:
    Constant Field Values
  - DFLT_WAL_SEGMENTS
```
public static final int DFLT_WAL_SEGMENTS
```
    See Also:
    Constant Field Values
  - DFLT_WAL_SEGMENT_SIZE
```
public static final int DFLT_WAL_SEGMENT_SIZE
```
    Default WAL file segment size, 64MBytes
    
    See Also:
    Constant Field Values
  - DFLT_WAL_MODE
```
public static final WALMode DFLT_WAL_MODE
```
    Default wal mode.
  - DFLT_TLB_SIZE
```
public static final int DFLT_TLB_SIZE
```
    Default thread local buffer size.
    
    See Also:
    Constant Field Values
  - DFLT_WAL_FLUSH_FREQ
```
public static final int DFLT_WAL_FLUSH_FREQ
```
    Default Wal flush frequency.
    
    See Also:
    Constant Field Values
  - DFLT_WAL_FSYNC_DELAY
```
public static final int DFLT_WAL_FSYNC_DELAY
```
    Default wal fsync delay.
    
    See Also:
    Constant Field Values
  - DFLT_WAL_RECORD_ITERATOR_BUFFER_SIZE
```
public static final int DFLT_WAL_RECORD_ITERATOR_BUFFER_SIZE
```
    Default wal record iterator buffer size.
    
    See Also:
    Constant Field Values
  - DFLT_WAL_ALWAYS_WRITE_FULL_PAGES
```
public static final boolean DFLT_WAL_ALWAYS_WRITE_FULL_PAGES
```
    Default wal always write full pages.
    
    See Also:
    Constant Field Values
  - DFLT_WAL_STORE_PATH
```
public static final String DFLT_WAL_STORE_PATH
```
    Default wal directory.
    
    See Also:
    Constant Field Values
  - DFLT_WAL_ARCHIVE_PATH
```
public static final String DFLT_WAL_ARCHIVE_PATH
```
    Default wal archive directory.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - PersistentStoreConfiguration
```
public PersistentStoreConfiguration()
```
- Method Detail
  - getPersistentStorePath
```
public String getPersistentStorePath()
```
    Returns a path the root directory where the Persistent Store will persist data and indexes.
  - setPersistentStorePath
```
public PersistentStoreConfiguration setPersistentStorePath(String persistenceStorePath)
```
    Sets a path to the root directory where the Persistent Store will persist data and indexes. By default the Persistent Store's files are located under Ignite work directory.
    
    Parameters:
    persistenceStorePath - Persistence store path.
  - getCheckpointingFrequency
```
public long getCheckpointingFrequency()
```
    Gets checkpointing frequency.
    
    Returns:
    checkpointing frequency in milliseconds.
  - setCheckpointingFrequency
```
public PersistentStoreConfiguration setCheckpointingFrequency(long checkpointingFreq)
```
    Sets the checkpointing frequency which is a minimal interval when the dirty pages will be written to the Persistent Store. If the rate is high, checkpointing will be triggered more frequently.
    
    Parameters:
    checkpointingFreq - checkpointing frequency in milliseconds.
    
    Returns:
    this for chaining.
  - getCheckpointingPageBufferSize
```
public long getCheckpointingPageBufferSize()
```
    Gets amount of memory allocated for a checkpointing temporary buffer.
    
    Returns:
    Checkpointing page buffer size in bytes or 0 for Ignite to choose the buffer size automatically.
  - setCheckpointingPageBufferSize
```
public PersistentStoreConfiguration setCheckpointingPageBufferSize(long checkpointingPageBufSize)
```
    Sets amount of memory allocated for the checkpointing temporary buffer. The buffer is used to create temporary copies of pages that are being written to disk and being update in parallel while the checkpointing is in progress.
    
    Parameters:
    checkpointingPageBufSize - Checkpointing page buffer size in bytes or 0 for Ignite to choose the buffer size automatically.
    
    Returns:
    this for chaining.
  - getCheckpointingThreads
```
public int getCheckpointingThreads()
```
    Gets a number of threads to use for the checkpointing purposes.
    
    Returns:
    Number of checkpointing threads.
  - setCheckpointingThreads
```
public PersistentStoreConfiguration setCheckpointingThreads(int checkpointingThreads)
```
    Sets a number of threads to use for the checkpointing purposes.
    
    Parameters:
    checkpointingThreads - Number of checkpointing threads. One thread is used by default.
    
    Returns:
    this for chaining.
  - getLockWaitTime
```
public long getLockWaitTime()
```
    Time out in milliseonds to wait when acquiring persistence store lock file before failing the local node.
    
    Returns:
    Lock wait time in milliseconds.
  - setLockWaitTime
```
public PersistentStoreConfiguration setLockWaitTime(long lockWaitTime)
```
    Time out in milliseconds to wait when acquiring persistence store lock file before failing the local node.
    
    Parameters:
    lockWaitTime - Lock wait time in milliseconds.
    
    Returns:
    this for chaining.
  - getWalHistorySize
```
public int getWalHistorySize()
```
    Gets a total number of checkpoints to keep in the WAL history.
    
    Returns:
    Number of checkpoints to keep in WAL after a checkpoint is finished.
  - setWalHistorySize
```
public PersistentStoreConfiguration setWalHistorySize(int walHistSize)
```
    Sets a total number of checkpoints to keep in the WAL history.
    
    Parameters:
    walHistSize - Number of checkpoints to keep after a checkpoint is finished.
    
    Returns:
    this for chaining.
  - getWalSegments
```
public int getWalSegments()
```
    Gets a number of WAL segments to work with.
    
    Returns:
    Number of work WAL segments.
  - setWalSegments
```
public PersistentStoreConfiguration setWalSegments(int walSegments)
```
    Sets a number of WAL segments to work with. For performance reasons, the whole WAL is split into files of fixed length called segments.
    
    Parameters:
    walSegments - Number of WAL segments.
    
    Returns:
    this for chaining.
  - getWalSegmentSize
```
public int getWalSegmentSize()
```
    Gets size of a WAL segment in bytes.
    
    Returns:
    WAL segment size.
  - setWalSegmentSize
```
public PersistentStoreConfiguration setWalSegmentSize(int walSegmentSize)
```
    Sets size of a WAL segment.
    
    Parameters:
    walSegmentSize - WAL segment size. 64 MB is used by default. Maximum value is 2Gb
    
    Returns:
    this for chaining.
  - getWalStorePath
```
public String getWalStorePath()
```
    Gets a path to the directory where WAL is stored.
    
    Returns:
    WAL persistence path, absolute or relative to Ignite work directory.
  - setWalStorePath
```
public PersistentStoreConfiguration setWalStorePath(String walStorePath)
```
    Sets a path to the directory where WAL is stored . If this path is relative, it will be resolved relatively to Ignite work directory.
    
    Parameters:
    walStorePath - WAL persistence path, absolute or relative to Ignite work directory.
    
    Returns:
    this for chaining.
  - getWalArchivePath
```
public String getWalArchivePath()
```
    Gets a path to the WAL archive directory.
    
    Returns:
    WAL archive directory.
  - setWalArchivePath
```
public PersistentStoreConfiguration setWalArchivePath(String walArchivePath)
```
    Sets a path for the WAL archive directory. Every WAL segment will be fully copied to this directory before it can be reused for WAL purposes.
    
    Parameters:
    walArchivePath - WAL archive directory.
    
    Returns:
    this for chaining.
  - isMetricsEnabled
```
public boolean isMetricsEnabled()
```
    Gets flag indicating whether persistence metrics collection is enabled. Default value is DFLT_METRICS_ENABLED.
    
    Returns:
    Metrics enabled flag.
  - setMetricsEnabled
```
public PersistentStoreConfiguration setMetricsEnabled(boolean metricsEnabled)
```
    Sets flag indicating whether persistence metrics collection is enabled.
    
    Parameters:
    metricsEnabled - Metrics enabled flag.
  - getRateTimeInterval
```
public long getRateTimeInterval()
```
    Gets the length of the time interval for rate-based metrics. This interval defines a window over which hits will be tracked. Default value is DFLT_RATE_TIME_INTERVAL_MILLIS.
    
    Returns:
    Time interval in milliseconds.
  - setRateTimeInterval
```
public PersistentStoreConfiguration setRateTimeInterval(long rateTimeInterval)
```
    Sets the length of the time interval for rate-based metrics. This interval defines a window over which hits will be tracked.
    
    Parameters:
    rateTimeInterval - Time interval in milliseconds.
  - getSubIntervals
```
public int getSubIntervals()
```
    Gets the number of sub-intervals to split the getRateTimeInterval() into to track the update history. Default value is DFLT_SUB_INTERVALS.
    
    Returns:
    The number of sub-intervals for history tracking.
  - setSubIntervals
```
public PersistentStoreConfiguration setSubIntervals(int subIntervals)
```
    Sets the number of sub-intervals to split the getRateTimeInterval() into to track the update history.
    
    Parameters:
    subIntervals - The number of sub-intervals for history tracking.
  - getWalMode
```
public WALMode getWalMode()
```
    Type define behavior wal fsync. Different type provide different guarantees for consistency.
    
    Returns:
    WAL mode.
  - setWalMode
```
public PersistentStoreConfiguration setWalMode(WALMode walMode)
```
    Parameters:
    walMode - Wal mode.
  - getTlbSize
```
public int getTlbSize()
```
    Property define size thread local buffer. Each thread which write to wal have thread local buffer for serialize recode before write in wal.
    
    Returns:
    Thread local buffer size.
  - setTlbSize
```
public PersistentStoreConfiguration setTlbSize(int tlbSize)
```
    Parameters:
    tlbSize - Tlb size.
  - getWalFlushFrequency
```
public long getWalFlushFrequency()
```
    This property define how often WAL will be fsync-ed in BACKGROUND mode. Ignored for all other WAL modes.
    
    Returns:
    WAL flush frequency, in milliseconds.
  - setWalFlushFrequency
```
public PersistentStoreConfiguration setWalFlushFrequency(long walFlushFreq)
```
    This property define how often WAL will be fsync-ed in BACKGROUND mode. Ignored for all other WAL modes.
    
    Parameters:
    walFlushFreq - WAL flush frequency, in milliseconds.
  - getWalFsyncDelayNanos
```
public long getWalFsyncDelayNanos()
```
    Gets the fsync delay, in nanoseconds.
  - setWalFsyncDelayNanos
```
public PersistentStoreConfiguration setWalFsyncDelayNanos(long walFsyncDelayNanos)
```
    Parameters:
    walFsyncDelayNanos - Wal fsync delay, in nanoseconds.
  - getWalRecordIteratorBufferSize
```
public int getWalRecordIteratorBufferSize()
```
    Property define how many bytes iterator read from disk (for one reading), during go ahead wal.
    
    Returns:
    Record iterator buffer size.
  - setWalRecordIteratorBufferSize
```
public PersistentStoreConfiguration setWalRecordIteratorBufferSize(int walRecordIterBuffSize)
```
    Parameters:
    walRecordIterBuffSize - Wal record iterator buffer size.
  - isAlwaysWriteFullPages
```
public boolean isAlwaysWriteFullPages()
```
  - setAlwaysWriteFullPages
```
public PersistentStoreConfiguration setAlwaysWriteFullPages(boolean alwaysWriteFullPages)
```
    Parameters:
    alwaysWriteFullPages - Always write full pages.
  - getFileIOFactory
```
public FileIOFactory getFileIOFactory()
```
    Factory to provide implementation of FileIO interface which is used for any file read/write operations
    
    Returns:
    File I/O factory
  - setFileIOFactory
```
public PersistentStoreConfiguration setFileIOFactory(FileIOFactory fileIOFactory)
```
    Parameters:
    fileIOFactory - File I/O factory
  - setWalAutoArchiveAfterInactivity
```
public PersistentStoreConfiguration setWalAutoArchiveAfterInactivity(long walAutoArchiveAfterInactivity)
```
    Note: setting this value with WALMode.DEFAULT may generate file size overhead for WAL segments in case grid is used rarely.
    
    Parameters:
    walAutoArchiveAfterInactivity - time in millis to run auto archiving segment (even if incomplete) after last record logging.
    Positive value enables incomplete segment archiving after timeout (inactivity).
    Zero or negative value disables auto archiving.
    
    Returns:
    current configuration instance for chaining
  - getWalAutoArchiveAfterInactivity
```
public long getWalAutoArchiveAfterInactivity()
```
    Returns:
    time in millis to run auto archiving WAL segment (even if incomplete) after last record log
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PersistentStoreConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DFLT_CHECKPOINTING_FREQ

DFLT_LOCK_WAIT_TIME

DFLT_METRICS_ENABLED

DFLT_SUB_INTERVALS

DFLT_RATE_TIME_INTERVAL_MILLIS

DFLT_CHECKPOINTING_THREADS

DFLT_WAL_HISTORY_SIZE

DFLT_WAL_SEGMENTS

DFLT_WAL_SEGMENT_SIZE

DFLT_WAL_MODE

DFLT_TLB_SIZE

DFLT_WAL_FLUSH_FREQ

DFLT_WAL_FSYNC_DELAY

DFLT_WAL_RECORD_ITERATOR_BUFFER_SIZE

DFLT_WAL_ALWAYS_WRITE_FULL_PAGES

DFLT_WAL_STORE_PATH

DFLT_WAL_ARCHIVE_PATH

Constructor Detail

PersistentStoreConfiguration

Method Detail

getPersistentStorePath

setPersistentStorePath

getCheckpointingFrequency

setCheckpointingFrequency

getCheckpointingPageBufferSize

setCheckpointingPageBufferSize

getCheckpointingThreads

setCheckpointingThreads

getLockWaitTime

setLockWaitTime

getWalHistorySize

setWalHistorySize

getWalSegments

setWalSegments

getWalSegmentSize

setWalSegmentSize

getWalStorePath

setWalStorePath

getWalArchivePath

setWalArchivePath

isMetricsEnabled

setMetricsEnabled

getRateTimeInterval

setRateTimeInterval

getSubIntervals

setSubIntervals

getWalMode

setWalMode

getTlbSize

setTlbSize

getWalFlushFrequency

setWalFlushFrequency

getWalFsyncDelayNanos

setWalFsyncDelayNanos

getWalRecordIteratorBufferSize

setWalRecordIteratorBufferSize

isAlwaysWriteFullPages

setAlwaysWriteFullPages

getFileIOFactory

setFileIOFactory

setWalAutoArchiveAfterInactivity

getWalAutoArchiveAfterInactivity

toString