Class IgniteConfiguration

Grid configuration.

Inheritance

System.Object

IgniteConfiguration

Namespace: Apache.Ignite.Core

Assembly: Apache.Ignite.Core.dll

Syntax

public class IgniteConfiguration : object

Constructors

IgniteConfiguration()

Initializes a new instance of the IgniteConfiguration class.

Declaration

public IgniteConfiguration()

IgniteConfiguration(IgniteConfiguration)

Initializes a new instance of the IgniteConfiguration class.

Declaration

public IgniteConfiguration(IgniteConfiguration configuration)

Parameters

Type	Name	Description
IgniteConfiguration	configuration	The configuration to copy.

Fields

DefaultAuthenticationEnabled

Default value for AuthenticationEnabled property.

Declaration

public const bool DefaultAuthenticationEnabled = null

Field Value

Type	Description
System.Boolean

DefaultClientConnectorConfigurationEnabled

Default value for ClientConnectorConfigurationEnabled.

Declaration

public const bool DefaultClientConnectorConfigurationEnabled = null

Field Value

Type	Description
System.Boolean

DefaultClientFailureDetectionTimeout

Default failure detection timeout.

Declaration

public static readonly TimeSpan DefaultClientFailureDetectionTimeout

Field Value

Type	Description
TimeSpan

DefaultFailureDetectionTimeout

Default failure detection timeout.

Declaration

public static readonly TimeSpan DefaultFailureDetectionTimeout

Field Value

Type	Description
TimeSpan

DefaultIsActiveOnStart

Default value for IsActiveOnStart property.

Declaration

public const bool DefaultIsActiveOnStart = null

Field Value

Type	Description
System.Boolean

DefaultIsLateAffinityAssignment

Default late affinity assignment mode.

Declaration

public const bool DefaultIsLateAffinityAssignment = null

Field Value

Type	Description
System.Boolean

DefaultJvmInitMem

Default initial JVM memory in megabytes.

Declaration

public const int DefaultJvmInitMem = null

Field Value

Type	Description
System.Int32

DefaultJvmMaxMem

Default maximum JVM memory in megabytes.

Declaration

public const int DefaultJvmMaxMem = null

Field Value

Type	Description
System.Int32

DefaultLongQueryWarningTimeout

Default timeout after which long query warning will be printed.

Declaration

public static readonly TimeSpan DefaultLongQueryWarningTimeout

Field Value

Type	Description
TimeSpan

DefaultManagementThreadPoolSize

Default management thread pool size.

Declaration

public const int DefaultManagementThreadPoolSize = null

Field Value

Type	Description
System.Int32

DefaultMetricsExpireTime

Default metrics expire time.

Declaration

public static readonly TimeSpan DefaultMetricsExpireTime

Field Value

Type	Description
TimeSpan

DefaultMetricsHistorySize

Default metrics history size.

Declaration

public const int DefaultMetricsHistorySize = null

Field Value

Type	Description
System.Int32

DefaultMetricsLogFrequency

Default metrics log frequency.

Declaration

public static readonly TimeSpan DefaultMetricsLogFrequency

Field Value

Type	Description
TimeSpan

DefaultMetricsUpdateFrequency

Default metrics update frequency.

Declaration

public static readonly TimeSpan DefaultMetricsUpdateFrequency

Field Value

Type	Description
TimeSpan

DefaultMvccVacuumFrequency

Default value for MvccVacuumFrequency property.

Declaration

public const long DefaultMvccVacuumFrequency = null

Field Value

Type	Description
System.Int64

DefaultMvccVacuumThreadCount

Default value for MvccVacuumThreadCount property.

Declaration

public const int DefaultMvccVacuumThreadCount = null

Field Value

Type	Description
System.Int32

DefaultNetworkSendRetryCount

Default network retry count.

Declaration

public const int DefaultNetworkSendRetryCount = null

Field Value

Type	Description
System.Int32

DefaultNetworkSendRetryDelay

Default network retry delay.

Declaration

public static readonly TimeSpan DefaultNetworkSendRetryDelay

Field Value

Type	Description
TimeSpan

DefaultNetworkTimeout

Default network timeout.

Declaration

public static readonly TimeSpan DefaultNetworkTimeout

Field Value

Type	Description
TimeSpan

DefaultRedirectJavaConsoleOutput

Default value for RedirectJavaConsoleOutput property.

Declaration

public const bool DefaultRedirectJavaConsoleOutput = null

Field Value

Type	Description
System.Boolean

DefaultSqlQueryHistorySize

Default value for SqlQueryHistorySize property.

Declaration

public const int DefaultSqlQueryHistorySize = null

Field Value

Type	Description
System.Int32

DefaultThreadPoolSize

Default thread pool size.

Declaration

public static readonly int DefaultThreadPoolSize

Field Value

Type	Description
System.Int32

Properties

Assemblies

List of additional .NET assemblies to load on Ignite start. Each item can be either fully qualified assembly name, path to assembly to DLL or path to a directory when assemblies reside.

Declaration

public ICollection<string> Assemblies { get; set; }

Property Value

Type	Description
ICollection<System.String>

AsyncCallbackThreadPoolSize

Gets or sets the size of the asynchronous callback thread pool.

Declaration

public int AsyncCallbackThreadPoolSize { get; set; }

Property Value

Type	Description
System.Int32

AsyncContinuationExecutor

Gets or sets the async continuation behavior. See AsyncContinuationExecutor members for more details.

Declaration

public AsyncContinuationExecutor AsyncContinuationExecutor { get; set; }

Property Value

Type	Description
AsyncContinuationExecutor

AtomicConfiguration

Gets or sets the atomic data structures configuration.

Declaration

public AtomicConfiguration AtomicConfiguration { get; set; }

Property Value

Type	Description
AtomicConfiguration

AuthenticationEnabled

Gets or sets whether user authentication is enabled for the cluster. Default is false.

Declaration

public bool AuthenticationEnabled { get; set; }

Property Value

Type	Description
System.Boolean

AutoGenerateIgniteInstanceName

Gets or sets a value indicating whether unique IgniteInstanceName should be generated.

Set this to true in scenarios where new node should be started regardless of other nodes present within current process. In particular, this setting is useful is ASP.NET and IIS environments, where AppDomains are loaded and unloaded within a single process during application restarts. Ignite stops all nodes on unload, however, IIS does not wait for previous AppDomain to unload before starting up a new one, which may cause "Ignite instance with this name has already been started" errors. This setting solves the issue.

Declaration

public bool AutoGenerateIgniteInstanceName { get; set; }

Property Value

Type	Description
System.Boolean

BinaryConfiguration

Gets or sets the binary configuration.

Declaration

public BinaryConfiguration BinaryConfiguration { get; set; }

Property Value

Type	Description
BinaryConfiguration	The binary configuration.

CacheConfiguration

Gets or sets the cache configuration.

Declaration

public ICollection<CacheConfiguration> CacheConfiguration { get; set; }

Property Value

Type	Description
ICollection<CacheConfiguration>	The cache configuration.

ClientConnectorConfiguration

Gets or sets the client connector configuration (for JDBC, ODBC, and thin clients).

Declaration

public ClientConnectorConfiguration ClientConnectorConfiguration { get; set; }

Property Value

Type	Description
ClientConnectorConfiguration

ClientConnectorConfigurationEnabled

Gets or sets a value indicating whether client connector is enabled: allow thin clients, ODBC and JDBC drivers to work with Ignite (see ClientConnectorConfiguration). Default is DefaultClientConnectorConfigurationEnabled.

Declaration

public bool ClientConnectorConfigurationEnabled { get; set; }

Property Value

Type	Description
System.Boolean

ClientFailureDetectionTimeout

Gets or sets the failure detection timeout used by TcpDiscoverySpi and TcpCommunicationSpi for client nodes.

Declaration

public TimeSpan ClientFailureDetectionTimeout { get; set; }

Property Value

Type	Description
TimeSpan

ClientMode

Gets or sets a value indicating whether node should start in client mode. Client node cannot hold data in the caches.

Declaration

public bool ClientMode { get; set; }

Property Value

Type	Description
System.Boolean

CommunicationSpi

Gets or sets the communication service provider. Null for default communication.

Declaration

public ICommunicationSpi CommunicationSpi { get; set; }

Property Value

Type	Description
ICommunicationSpi

ConsistentId

Gets or sets consistent globally unique node identifier which survives node restarts.

Declaration

public object ConsistentId { get; set; }

Property Value

Type	Description
System.Object

DataStorageConfiguration

Gets or sets the data storage configuration.

Declaration

public DataStorageConfiguration DataStorageConfiguration { get; set; }

Property Value

Type	Description
DataStorageConfiguration

DataStreamerThreadPoolSize

Gets or sets the size of the data streamer thread pool.

Declaration

public int DataStreamerThreadPoolSize { get; set; }

Property Value

Type	Description
System.Int32

DiscoverySpi

Gets or sets the discovery service provider. Null for default discovery.

Declaration

public IDiscoverySpi DiscoverySpi { get; set; }

Property Value

Type	Description
IDiscoverySpi

EncryptionSpi

Gets or sets the encryption service provider. Null for disabled encryption.

Declaration

public IEncryptionSpi EncryptionSpi { get; set; }

Property Value

Type	Description
IEncryptionSpi

EventStorageSpi

Gets or sets the event storage interface.

Only predefined implementations are supported: NoopEventStorageSpi, MemoryEventStorageSpi.

Declaration

public IEventStorageSpi EventStorageSpi { get; set; }

Property Value

Type	Description
IEventStorageSpi

ExecutorConfiguration

Gets or sets custom executor configuration for compute tasks.

Declaration

public ICollection<ExecutorConfiguration> ExecutorConfiguration { get; set; }

Property Value

Type	Description
ICollection<ExecutorConfiguration>

FailureDetectionTimeout

Gets or sets the failure detection timeout used by TcpDiscoverySpi and TcpCommunicationSpi.

Declaration

public TimeSpan FailureDetectionTimeout { get; set; }

Property Value

Type	Description
TimeSpan

FailureHandler

Gets or sets predefined failure handlers implementation. A failure handler handles critical failures of Ignite instance accordingly:

NoOpFailureHandler -- do nothing.

StopNodeFailureHandler -- stop node.

StopNodeOrHaltFailureHandler -- try to stop node if tryStop value is true. If node can't be stopped during provided timeout or tryStop value is false then JVM process will be terminated forcibly.

Only these implementations are supported: NoOpFailureHandler, StopNodeOrHaltFailureHandler, StopNodeFailureHandler.

Declaration

public IFailureHandler FailureHandler { get; set; }

Property Value

Type	Description
IFailureHandler

GridName

Gets or sets optional local instance name.

This name only works locally and has no effect on topology.

This property is used to when there are multiple Ignite nodes in one process to distinguish them.

Declaration

public string GridName { get; set; }

Property Value

Type	Description
System.String

IgniteHome

Path to Ignite home. If not set environment variable IGNITE_HOME will be used.

Declaration

public string IgniteHome { get; set; }

Property Value

Type	Description
System.String

IgniteInstanceName

Gets or sets optional local instance name.

This name only works locally and has no effect on topology.

This property is used to when there are multiple Ignite nodes in one process to distinguish them.

Declaration

public string IgniteInstanceName { get; set; }

Property Value

Type	Description
System.String

IncludedEventTypes

Gets or sets a set of event types (EventType) to be recorded by Ignite.

Declaration

public ICollection<int> IncludedEventTypes { get; set; }

Property Value

Type	Description
ICollection<System.Int32>

IsActiveOnStart

Gets or sets a value indicating whether grid should be active on start. See also IsActive() and SetActive(Boolean).

This property is ignored when DataStorageConfiguration is present: cluster is always inactive on start when Ignite Persistence is enabled.

Declaration

public bool IsActiveOnStart { get; set; }

Property Value

Type	Description
System.Boolean

IsDaemon

Gets or sets a value indicating whether this node should be a daemon node.

Daemon nodes are the usual grid nodes that participate in topology but not visible on the main APIs, i.e. they are not part of any cluster groups.

Daemon nodes are used primarily for management and monitoring functionality that is built on Ignite and needs to participate in the topology, but also needs to be excluded from the "normal" topology, so that it won't participate in the task execution or in-memory data grid storage.

Declaration

public bool IsDaemon { get; set; }

Property Value

Type	Description
System.Boolean

IsLateAffinityAssignment

Gets or sets a value indicating whether late affinity assignment mode should be used.

On each topology change, for each started cache, partition-to-node mapping is calculated using AffinityFunction for cache. When late affinity assignment mode is disabled then new affinity mapping is applied immediately.

With late affinity assignment mode, if primary node was changed for some partition, but data for this partition is not rebalanced yet on this node, then current primary is not changed and new primary is temporary assigned as backup. This nodes becomes primary only when rebalancing for all assigned primary partitions is finished. This mode can show better performance for cache operations, since when cache primary node executes some operation and data is not rebalanced yet, then it sends additional message to force rebalancing from other nodes.

Note, that ICacheAffinity interface provides assignment information taking late assignment into account, so while rebalancing for new primary nodes is not finished it can return assignment which differs from assignment calculated by AffinityFunction.

This property should have the same value for all nodes in cluster.

If not provided, default value is DefaultIsLateAffinityAssignment.

Declaration

public bool IsLateAffinityAssignment { get; set; }

Property Value

Type	Description
System.Boolean

JavaPeerClassLoadingEnabled

Gets or sets a value indicating whether peer class loading is enabled for Java side.

When peer class loading is enabled and task is not deployed on local node, local node will try to load classes from the node that initiated task execution.

Important! PeerAssemblyLoadingMode and peer class loading in Java are two distinct and independent features.

Declaration

public bool JavaPeerClassLoadingEnabled { get; set; }

Property Value

Type	Description
System.Boolean

JvmClasspath

Classpath used by JVM on Ignite start.

Declaration

public string JvmClasspath { get; set; }

Property Value

Type	Description
System.String

JvmDllPath

Path to jvm.dll (libjvm.so on Linux, libjvm.dylib on Mac) file. If not set, it's location will be determined using JAVA_HOME environment variable. If path is neither set nor determined automatically, an exception will be thrown.

Declaration

public string JvmDllPath { get; set; }

Property Value

Type	Description
System.String

JvmInitialMemoryMb

Initial amount of memory in megabytes given to JVM. Maps to -Xms Java option.

-1

maps to JVM defaults.

Defaults to DefaultJvmInitMem.

Declaration

public int JvmInitialMemoryMb { get; set; }

Property Value

Type	Description
System.Int32

JvmMaxMemoryMb

Maximum amount of memory in megabytes given to JVM. Maps to -Xmx Java option.

-1

maps to JVM defaults.

Defaults to DefaultJvmMaxMem.

Declaration

public int JvmMaxMemoryMb { get; set; }

Property Value

Type	Description
System.Int32

JvmOptions

Collection of options passed to JVM on Ignite start.

Declaration

public ICollection<string> JvmOptions { get; set; }

Property Value

Type	Description
ICollection<System.String>

LifecycleHandlers

Lifecycle handlers.

Declaration

public ICollection<ILifecycleHandler> LifecycleHandlers { get; set; }

Property Value

Type	Description
ICollection<ILifecycleHandler>

LocalEventListeners

Gets or sets pre-configured local event listeners.

This is similar to calling LocalListen<T>(IEventListener<T>, Int32[]), but important difference is that some events occur during startup and can be only received this way.

Declaration

public ICollection<LocalEventListener> LocalEventListeners { get; set; }

Property Value

Type	Description
ICollection<LocalEventListener>

Localhost

Gets or sets system-wide local address or host for all Ignite components to bind to. If provided it will override all default local bind settings within Ignite.

If null then Ignite tries to use local wildcard address.That means that all services will be available on all network interfaces of the host machine.

It is strongly recommended to set this parameter for all production environments.

Declaration

public string Localhost { get; set; }

Property Value

Type	Description
System.String

Logger

Gets or sets the logger.

If no logger is set, logging is delegated to Java, which uses the logger defined in Spring XML (if present) or logs to console otherwise.

Declaration

public ILogger Logger { get; set; }

Property Value

Type	Description
ILogger

LongQueryWarningTimeout

Gets or sets the timeout after which long query warning will be printed.

Declaration

public TimeSpan LongQueryWarningTimeout { get; set; }

Property Value

Type	Description
TimeSpan

ManagementThreadPoolSize

Gets or sets the size of the management thread pool, which processes internal Ignite jobs.

Declaration

public int ManagementThreadPoolSize { get; set; }

Property Value

Type	Description
System.Int32

MemoryConfiguration

Gets or sets the page memory configuration. MemoryConfiguration for more details.

Obsolete, use DataStorageConfiguration.

Declaration

public MemoryConfiguration MemoryConfiguration { get; set; }

Property Value

Type	Description
MemoryConfiguration

MetricsExpireTime

Gets or sets the time after which a certain metric value is considered expired.

Declaration

public TimeSpan MetricsExpireTime { get; set; }

Property Value

Type	Description
TimeSpan

MetricsHistorySize

Gets or sets the number of metrics kept in history to compute totals and averages.

Declaration

public int MetricsHistorySize { get; set; }

Property Value

Type	Description
System.Int32

MetricsLogFrequency

Gets or sets the frequency of metrics log print out. to disable metrics print out.

Declaration

public TimeSpan MetricsLogFrequency { get; set; }

Property Value

Type	Description
TimeSpan

MetricsUpdateFrequency

Gets or sets the job metrics update frequency. to update metrics on job start/finish. Negative value to never update metrics.

Declaration

public TimeSpan MetricsUpdateFrequency { get; set; }

Property Value

Type	Description
TimeSpan

MvccVacuumFrequency

This is an experimental feature. Transactional SQL is currently in a beta status.

Time interval between MVCC vacuum runs in milliseconds.

Declaration

public long MvccVacuumFrequency { get; set; }

Property Value

Type	Description
System.Int64

MvccVacuumThreadCount

This is an experimental feature. Transactional SQL is currently in a beta status.

Number of MVCC vacuum threads.

Declaration

public int MvccVacuumThreadCount { get; set; }

Property Value

Type	Description
System.Int32

NetworkSendRetryCount

Gets or sets the network send retry count.

Declaration

public int NetworkSendRetryCount { get; set; }

Property Value

Type	Description
System.Int32

NetworkSendRetryDelay

Gets or sets the network send retry delay.

Declaration

public TimeSpan NetworkSendRetryDelay { get; set; }

Property Value

Type	Description
TimeSpan

NetworkTimeout

Gets or sets the network timeout.

Declaration

public TimeSpan NetworkTimeout { get; set; }

Property Value

Type	Description
TimeSpan

PeerAssemblyLoadingMode

Gets or sets a value indicating how user assemblies should be loaded on remote nodes.

For example, when executing Call<TRes>(IComputeFunc<TRes>), the assembly with corresponding IComputeFunc<TRes> should be loaded on remote nodes. With this option enabled, Ignite will attempt to send the assembly to remote nodes and load it there automatically.

Default is Disabled.

Peer loading is enabled for ICompute functionality.

Declaration

public PeerAssemblyLoadingMode PeerAssemblyLoadingMode { get; set; }

Property Value

Type	Description
PeerAssemblyLoadingMode

PersistentStoreConfiguration

Gets or sets the persistent store configuration.

Obsolete, use DataStorageConfiguration.

Declaration

public PersistentStoreConfiguration PersistentStoreConfiguration { get; set; }

Property Value

Type	Description
PersistentStoreConfiguration

PluginConfigurations

Gets or sets the configurations for plugins to be started.

Declaration

public ICollection<IPluginConfiguration> PluginConfigurations { get; set; }

Property Value

Type	Description
ICollection<IPluginConfiguration>

PublicThreadPoolSize

Gets or sets the size of the public thread pool, which processes compute jobs and user messages.

Declaration

public int PublicThreadPoolSize { get; set; }

Property Value

Type	Description
System.Int32

QueryThreadPoolSize

Gets or sets the size of the query thread pool.

Declaration

public int QueryThreadPoolSize { get; set; }

Property Value

Type	Description
System.Int32

RedirectJavaConsoleOutput

Gets or sets a value indicating whether Java console output should be redirected to and , respectively.

Default is DefaultRedirectJavaConsoleOutput.

Java code outputs valuable information to console. However, since that is Java console, it is not possible to capture that output with standard .NET APIs (). As a result, many tools (IDEs, test runners) are not able to display Ignite console output in UI.

This property is enabled by default and redirects Java console output to standard .NET console. It is recommended to disable this in production.

Declaration

public bool RedirectJavaConsoleOutput { get; set; }

Property Value

Type	Description
System.Boolean

ServiceThreadPoolSize

Gets or sets the size of the service thread pool, which processes Ignite services.

Declaration

public int ServiceThreadPoolSize { get; set; }

Property Value

Type	Description
System.Int32

SpringConfigUrl

URL to Spring configuration file.

Spring configuration is loaded first, then IgniteConfiguration properties are applied. Null property values do not override Spring values. Value-typed properties are tracked internally: if setter was not called, Spring value won't be overwritten.

This merging happens on the top level only; e. g. if there are cache configurations defined in Spring and in .NET, .NET caches will overwrite Spring caches.

Declaration

public string SpringConfigUrl { get; set; }

Property Value

Type	Description
System.String

SqlConnectorConfiguration

Gets or sets the SQL connector configuration (for JDBC and ODBC).

Declaration

public SqlConnectorConfiguration SqlConnectorConfiguration { get; set; }

Property Value

Type	Description
SqlConnectorConfiguration

SqlQueryHistorySize

Gets or sets the value indicating the number of SQL query history elements to keep in memory. Zero or negative value disables the history.

Declaration

public int SqlQueryHistorySize { get; set; }

Property Value

Type	Description
System.Int32

SqlSchemas

Gets or sets SQL schemas to be created on node startup. Schemas are created on local node only and are not propagated. to other cluster nodes. Created schemas cannot be dropped.

By default schema names are case-insensitive. Use quotes to enforce case sensitivity.

Declaration

public ICollection<string> SqlSchemas { get; set; }

Property Value

Type	Description
ICollection<System.String>

SslContextFactory

Gets or sets the SSL context factory that will be used for creating a secure socket layer b/w nodes.

Default is null (no SSL).

Declaration

public ISslContextFactory SslContextFactory { get; set; }

Property Value

Type	Description
ISslContextFactory

StripedThreadPoolSize

Gets or sets the size of the striped thread pool, which processes cache requests.

Declaration

public int StripedThreadPoolSize { get; set; }

Property Value

Type	Description
System.Int32

SuppressWarnings

Whether to suppress warnings.

Declaration

public bool SuppressWarnings { get; set; }

Property Value

Type	Description
System.Boolean

SystemThreadPoolSize

Gets or sets the size of the system thread pool, which processes internal system messages.

Declaration

public int SystemThreadPoolSize { get; set; }

Property Value

Type	Description
System.Int32

SystemWorkerBlockedTimeout

Gets or sets the timeout for blocked system workers detection.

Declaration

public TimeSpan? SystemWorkerBlockedTimeout { get; set; }

Property Value

Type	Description
System.Nullable<TimeSpan>

TransactionConfiguration

Gets or sets the transaction configuration.

Declaration

public TransactionConfiguration TransactionConfiguration { get; set; }

Property Value

Type	Description
TransactionConfiguration

UserAttributes

Gets or sets the user attributes for this node.

These attributes can be retrieved later via Attributes. Environment variables are added to node attributes automatically. NOTE: attribute names starting with "org.apache.ignite" are reserved for internal use.

Declaration

public IDictionary<string, object> UserAttributes { get; set; }

Property Value

Type	Description
IDictionary<System.String, System.Object>

UtilityCacheThreadPoolSize

Gets or sets the size of the utility cache thread pool.

Declaration

public int UtilityCacheThreadPoolSize { get; set; }

Property Value

Type	Description
System.Int32

WorkDirectory

Gets or sets the work directory. If not provided, a folder under IgniteHome will be used.

Declaration

public string WorkDirectory { get; set; }

Property Value

Type	Description
System.String

Methods

FromXml(String)

Deserializes IgniteConfiguration from the XML string.

Declaration

public static IgniteConfiguration FromXml(string xml)

Parameters

Type	Name	Description
System.String	xml	Xml string.

Returns

Type	Description
IgniteConfiguration	Deserialized instance.

FromXml(XmlReader)

Deserializes IgniteConfiguration from the XML reader.

Declaration

public static IgniteConfiguration FromXml(XmlReader reader)

Parameters

Type	Name	Description
XmlReader	reader	The reader.

Returns

Type	Description
IgniteConfiguration	Deserialized instance.

ToXml()

Serializes this instance to an XML string.

Declaration

public string ToXml()

Returns

Type	Description
System.String

ToXml(XmlWriter, String)

Serializes this instance to the specified XML writer.

Declaration

public void ToXml(XmlWriter writer, string rootElementName)

Parameters

Type	Name	Description
XmlWriter	writer	The writer.
System.String	rootElementName	Name of the root element.