Apache Ignite Advanced Properties
The following tables list the advanced properties that you can add to the store.xml file for Apache Ignite. The table lists the property key names that are unique for each property and data type. You can provide the UI display name and default value as you want in store.xml.
For details about the attributes of the property tag, see XML Tags of the store.xml File.
IgniteConfiguration
The following properties define the configuration parameters required to start a grid instance.
| Property | Type | Description |
|---|---|---|
| long-query-timeout | Long | Sets a timeout in milliseconds after which a long query warning is printed. |
| management-thread-pool-size | Integer | Sets the management thread pool size to use within the grid. |
| metrics-expire-time | Long | Sets the time in milliseconds after which a certain metric value is considered expired. |
| metrics-history-size | Integer | Sets the number of metrics kept in history to compute totals and averages. |
| metrics-log-frequency | Long | Sets the frequency of metrics log printout. |
| metrics-update-frequency | Long | Sets Apache Ignite metrics update frequency in milliseconds. |
| network-compression-level | Integer | Compression level for internal network messages. |
| network-send-retry-level | Integer | Sets the counts of message send retries. |
| peer-class-loading-thread-pool-size | Integer | Sets the thread pool size to use for peer class loading. |
| public-thread-pool-size | Integer | Sets the thread pool size to use within the grid. |
| query-thread-pool-size | Integer | Sets the query thread pool size to use within the grid. |
| rebalance-batch-prefered-count | Long | The number of batches generated by a supply node at the re-balancing procedure start. |
| rebalance-batch-size | Integer | The supply message size in bytes to be loaded within a single rebalance batch. |
| rebalance-thread-pool-size | Integer | Sets Max count of threads can be used at re-balancing. |
| rebalance-throttle | Long | Time in milliseconds to wait between rebalance messages to avoid overloading of the CPU or network. |
| rebalance-timeout | Long | Rebalance timeout for supply and demand messages in milliseconds. |
| service-thread-pool-size | Integer | Sets the service thread pool size to use within the grid. |
| system-thread-pool-size | Integer | Sets the system thread pool size to use within the grid. |
| system-worker-blocker-timeout | Long | Sets a maximum inactivity period for system worker. |
| utility-cache-alive-time | Long | Sets keep alive the time of thread pool size that will be used to process utility cache messages. |
| utility-cache-pool-size | Integer | Sets the default thread pool size that will be used to process utility cache messages. |
| striped-pool-size | Integer | Sets striped pool size that should be used for cache requests processing. |
| enable-authentication | Boolean |
Enables user authentication for Apache Ignite. Note: Authentication can be enabled only for the cluster
with enabled persistence.
|
DataStorageConfiguration
The following properties define the configuration parameters required for persistence.
| Property Key | Data Type | Description |
|---|---|---|
| write-full-page | Boolean | Sets a flag that enforces writing full page to write-ahead log (WAL) on every change (instead of delta record). |
| checkpoint-frequency | Long | Sets the checkpoint frequency that is a minimum interval when the dirty pages are written to the persistent store. |
| checkpoint-lock-timeout | Long | Sets a timeout for the checkpoint read lock acquisition. |
| checkpoint-threads | Integer | The number of threads to use for checkpoint purposes. |
| concurrency-level | Integer | The number of concurrent segments in Apache Ignite internal page-mapping tables. |
| lock-timeout | Long | Timeout in milliseconds to wait when acquiring a persistence store locks file before failing the local node. |
| wal-archive-size | Long | Sets a maximum allowed size (in bytes) of WAL archives. |
| metric-enabled | Boolean | Sets a flag indicating whether persistence metrics collection is enabled. |
| page-size | Integer | Configures the page size. |
| wal-archive-path | String | Configures the path for the WAL archive directory. |
| wal-buffer-size | Integer | The size in bytes of WAL buffer. |
| wal-compaction-enable | Boolean | Sets a flag indicating whether WAL compaction is enabled. |
| wal-compaction-level | Integer | New archive level to WAL compaction. |
| wal-flush-frequency | Long | The frequency WAL is fsync-ed in the BACKGROUND mode. |
| wal-fsync-delay-nanos | Long | Sets a property that allows to trade latency for throughput in WALMode.FSYNC mode. |
| wal-page-compression-level | Integer | Sets algorithm specific page compression level. |
| wal-store-path | String | Sets a path to the directory where WAL is stored. |
| wal-record-buffer-size | Integer | Sets a property defining how many bytes iterator read from disk (for one reading), during go ahead wal. |
| wal-segments | Integer | The number of WAL segments to work with. |
| wal-segment-size | Integer | The size in bytes of a WAL segment. |
| wal-thread-local-buffer-size | Integer | The size of thread local buffer. |
| write-throttling-enable | Boolean | Sets a flag indicating whether write throttling is enabled. |
| wal-page-compression | String | Configures the algorithm specific page compression. |
| wal-mode | String | Configures the WAL mode. |
| wal-archive-after-inactivity | Long | Sets the time in millisecond to run the auto-archiving segment (even if incomplete) after the last record is logged. |
| checkpoint-threads | Integer | Sets the number of threads to use during a checkpoint. |
| checkpoint-write-order | String | Order (RANDOM/SEQUENTIAL) of writing pages to the disk storage during a checkpoint. |
| data-storage-defrag-thread-pool-size | Integer | Defragmentation thread pool size. |
| wal-min-archive-size | Long | Configure WAL archive minimum size. |
DataRegionConfiguration
The following properties define the configuration parameters required for a data region.
| Property Key | Data Type | Description |
|---|---|---|
| default-data-region-initial-size | Long | Sets the initial memory region size defined by this data region. |
| default-data-region-max-size | Long | Sets the maximum memory region size defined by this data region. |
| data-region-initial-size | Long | Sets the initial memory region size defined by this data region. |
| data-region-max-size | Long | Sets the maximum memory region size defined by this data region. |
| data-region-metrics-enabled | Boolean | Enables metrics for this data region. |
| data-region-empty-page-pool-size | Integer | Specifies the minimal number of empty pages to be present in reuse lists for this data region. |
| data-region-checkpoint-page-buffer-size | Long | Sets the amount of memory to be allocated for the checkpoint temporary buffer. When the checkpoint is in progress, this buffer is used to create temporary copies of pages that are being written to disk and updated in parallel. |
| data-region-eviction-threshold | Double | The eviction threshold of Data regions. |
| data-region-lazy-memory-allocation | Boolean | Enable lazy memory allocation for Data regions. |
| data-region-cdc-enabled | Boolean | Enable Data region CDC. |
| data-region-page-eviction-mode | String | Configures the data region page eviction mode. |
| data-region-page-replacement-mode | String | Configures the data region page replacement mode. |
| data-region-swap-path | String | Data region swap path. |
CacheConfiguration
The following properties define the configuration parameters required to start a cache within a grid instance.
| Property Key | Data Type | Description |
|---|---|---|
| disk-page-compression-level | Integer | The algorithm-specific disk page compression level. |
| egaer-ttl | Boolean | Sets the eager TTL flag. |
| event-disable | Boolean | Sets the events disabled flag. |
| mangement-enable | Boolean | Enables management |
| max-conc-async-oper | Integer | The maximum number of concurrent asynchronous operations. |
| query-iter-count | Integer | The maximum number of query iterators that can be stored. |
| onheap-cache-enable | Boolean | Configures on-heap cache for the off-heap based page memory. |
| query-detail-metrics-size | Integer | The size of queries detail metrics that is stored in memory for monitoring purposes. |
| query-parallelism | Integer | Sets query parallelism. |
| read-from-backup | Boolean | Sets read from the backup flag. |
| rebalance-mode | String(ASYNC/NONE/SYNC) |
Sets cache rebalance mode. |
| rebalance-order | Integer | Sets cache rebalance order. |
| sql-inline-size | Integer | Sets maximum inline size for SQL indexes. |
| sql-onheap-enable | Boolean | Sets whether SQL on-heap cache is enabled. |
| sql-onheap-size | Integer | Sets maximum SQL on-heap cache. |
| statistics-enable | Boolean | Enable Statistics. |
| store-conc-load-threshold | Integer | Sets the concurrent load-all threshold used for cases when keys' values are being loaded from CacheStore in parallel. |
TCP Communication SPI
The following properties define the configuration parameters required for the TCP Communication SPI.
| Property | Type | Description |
|---|---|---|
| tcp-communication-spi-ack-send-threshold | Integer | TCP Communication SPI acknowledgment sends a threshold. |
| tcp-communication-spi-max-connections-per-node | Integer | TCP Communication SPI maximum connections per node. |
| tcp-communication-spi-direct-buffer | Boolean | Enable SPI direct buffer. |
| tcp-communication-spi-direct-send-buffer | Boolean | Enable SPI direct send buffer. |
| tcp-communication-spi-filter-reachable-addresses | Boolean | Enable TCP Communication SPI filter reachable addresses. |
| tcp-communication-spi-force-client-to-server-connections | Boolean | Enable force clients to server connections. |
| tcp-communication-spi-idle-connection-timeout | Long | Configure an idle connection timeout. |
| tcp-communication-spi-local-address | String |
Configure the local address. Note: Use the
be.engine.hostaddress property to configure the tcp-communication-spi-local-address value. |
| tcp-communication-spi-max-connection-timeout | Long | Maximum connection timeout. |
| tcp-communication-spi-msg-queue-limit | Integer | Configure a message Queue limit. |
| tcp-communication-spi-name | String | Configure the SPI name. |
| tcp-communication-spi-reconnect-count | Integer | Configure the SPI reconnect count. |
| tcp-communication-spi-selectors-count | Integer | Configure SPI selectors count. |
| tcp-communication-spi-selector-spins | Long | Configure the SPI selector spins. |
| tcp-communication-spi-slowclient-queue-limit | Integer | Configure a slow client queue limit. |
| tcp-communication-spi-socket-receive-buffer | Integer | Configure a socket receive buffer. |
| tcp-communication-spi-socket-send-buffer | Integer | Configure a socket send buffer. |
| tcp-communication-spi-tcp-no-delay | Boolean | Enable TCP no delay. |
| tcp-communication-spi-unacked-msg-buffer-size | Integer | Configure unacknowledged messages buffer size. |
| tcp-communication-spi-use-paired-connections | Boolean | Enable use paired connections. |