Table of Contents

Namespace Apache.Ignite

Classes

BasicAuthenticator

Basic authenticator with username and password.

Credentials are sent to the server in plain text, unless SSL/TLS is enabled - see SslStreamFactory.
ClusterInitFailureException

Thrown when cluster initialization failed.

ClusterNotInitializedException

Thrown when cluster is not yet initialized.

ColumnAlreadyExistsException

This exception is thrown when a column creation has failed because a column with the specified name already existed. @deprecated No longer used. Use {@link org.apache.ignite.sql.SqlException} with {@link ErrorGroups.Sql#STMT_VALIDATION_ERR} error code.

ColumnNotFoundException

Exception is thrown when the indicated column is not found.

CursorClosedException

Exception is thrown when a data fetch attempt is performed on a closed cursor.

ErrorGroups

Represents a concept of error group. Error group defines a collection of errors that belong to a single semantic component. Each group can be identified by a name and an integer number that both must be unique across all error groups.

ErrorGroups.Authentication

Authentication errors.

ErrorGroups.Cache

Cache errors.

ErrorGroups.CacheStore

CacheStore errors.

ErrorGroups.Catalog

Catalog errors.

ErrorGroups.Cdc

Cdc errors.

ErrorGroups.Client

Client errors.

ErrorGroups.CodeDeployment

CodeDeployment errors.

ErrorGroups.Common

Common errors.

ErrorGroups.CommonConfiguration

CommonConfiguration errors.

ErrorGroups.Compute

Compute errors.

ErrorGroups.ContinuousQuery

ContinuousQuery errors.

ErrorGroups.CriticalWorkers

CriticalWorkers errors.

ErrorGroups.DataCenterReplication

DataCenterReplication errors.

ErrorGroups.DisasterRecovery

DisasterRecovery errors.

ErrorGroups.DistributionZones

DistributionZones errors.

ErrorGroups.Embedded

Embedded errors.

ErrorGroups.Encryption

Encryption errors.

ErrorGroups.GarbageCollector

GarbageCollector errors.

ErrorGroups.Index

Index errors.

ErrorGroups.Jwt

Jwt errors.

ErrorGroups.Ldap

Ldap errors.

ErrorGroups.License

License errors.

ErrorGroups.Marshalling

Marshalling errors.

ErrorGroups.MemoryQuota

MemoryQuota errors.

ErrorGroups.MetaStorage

MetaStorage errors.

ErrorGroups.Network

Network errors.

ErrorGroups.NodeConfiguration

NodeConfiguration errors.

ErrorGroups.NodeKeyManagement

NodeKeyManagement errors.

ErrorGroups.PlacementDriver

PlacementDriver errors.

ErrorGroups.PointInTimeRecovery

PointInTimeRecovery errors.

ErrorGroups.Rbac

Rbac errors.

ErrorGroups.Replicator

Replicator errors.

ErrorGroups.Rest

Rest errors.

ErrorGroups.SecondaryStorage

SecondaryStorage errors.

ErrorGroups.Security

Security errors.

ErrorGroups.Snapshots

Snapshots errors.

ErrorGroups.Sql

Sql errors.

ErrorGroups.Storage

Storage errors.

ErrorGroups.Table

Table errors.

ErrorGroups.Transactions

Transactions errors.

IgniteClient

Ignite client builder.

IgniteClientConfiguration

Ignite client driver configuration.

IgniteClientConnectionException

Ignite thin client exception.

IgniteClientException

Ignite thin client exception.

IgniteClientGroup

Ignite client group. Thread safe.

Creates and maintains up to Size Ignite clients and returns them in a round-robin fashion. Ignite clients are thread safe, so there is no rent/return semantics.

Register as a singleton in DI container:
builder.Services.AddSingleton(_ => new IgniteClientGroup(
    new IgniteClientGroupConfiguration
    {
        Size = 3,
        ClientConfiguration = new("localhost"),
    }));
Invoke from a controller:
public async Task<IActionResult> Index([FromServices] IgniteClientGroup igniteGroup)
{
    IIgnite ignite = await igniteGroup.GetIgniteAsync();
    var tables = await ignite.Tables.GetTablesAsync();
    return Ok(tables);
}
IgniteClientGroupConfiguration

Ignite client group configuration. See IgniteClientGroup for more details.

IgniteException

Ignite exception.

IgniteServiceCollectionExtensions

Extension methods for setting up Apache Ignite services in an IServiceCollection.

IndexAlreadyExistsException

This exception is thrown when a new index creation has failed because an index with the specified name already existed. @deprecated No longer used. Use {@link org.apache.ignite.sql.SqlException} with {@link ErrorGroups.Sql#STMT_VALIDATION_ERR} error code.

IndexNotFoundException

Exception is thrown when the specified index is not found. @deprecated No longer used. Use {@link org.apache.ignite.sql.SqlException} with {@link ErrorGroups.Sql#STMT_VALIDATION_ERR} error code.

MarshallerException

This exception is caused by a failure to marshall or unmarshall a value. The failure can be due to a value not matching the a schema or to another reason.

MetricNames

Ignite.NET client metrics.

CLI usage example:
dotnet-counters monitor --counters Apache.Ignite,System.Runtime --process-id PID
See https://learn.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-counters for details.

Code usage example:
var meterListener = new MeterListener();

meterListener.InstrumentPublished = (instrument, listener) => { if (instrument.Meter.Name == MetricNames.MeterName) { listener.EnableMeasurementEvents(instrument); Console.WriteLine($"Instrument enabled: {instrument.Name}"); } };

meterListener.SetMeasurementEventCallback<long>((instrument, measurement, tags, state) => Console.WriteLine($"{instrument.Name}: {measurement}"));

meterListener.SetMeasurementEventCallback<int>((instrument, measurement, tags, state) => Console.WriteLine($"{instrument.Name}: {measurement}"));

meterListener.Start();

See https://learn.microsoft.com/en-us/dotnet/core/diagnostics/metrics for details.
MetricTags

Metric tag names. See also MetricNames.

NodeNotStartedException

Thrown when embedded node is not yet started or it's already stopped.

NodeStartException

Thrown when node failed to start.

Option

Static helpers for Option<T>.

RetryLimitPolicy

Retry policy that returns true when Iteration is less than the specified RetryLimit, or the limit is zero or less.

RetryNonePolicy

Retry policy that always returns false.

RetryReadPolicy

Retry policy that returns true for all read-only operations that do not modify data.

SchemaNotFoundException

Exception is thrown when a specified schema cannot be found. @deprecated No longer used. Use {@link org.apache.ignite.sql.SqlException} with {@link ErrorGroups.Sql#STMT_VALIDATION_ERR} error code.

SslStreamFactory

Standard SSL stream factory. Can be used with or without client-side certificates.

TableAlreadyExistsException

This exception is thrown when a table creation has failed because a table with the specified name already existed. @deprecated No longer used. Use {@link org.apache.ignite.sql.SqlException} with {@link ErrorGroups.Sql#STMT_VALIDATION_ERR} error code.

TableNotFoundException

Exception is thrown when a specified table cannot be found.

UnexpectedNullValueException

This exception is thrown instead of returning a null value from a method that does not respect {@code null}-value to avoid ambiguity (whether the value is absent or is {@code null}).

UnsupportedPartitionTypeException

This exception is thrown when a table does not support the specified partition type.

Structs

BigDecimal

Big decimal.

Ignite supports values with up to MaxValue precision (in tables, SQL, Compute, and other APIs). .NET decimal has 28-29 digit precision and can not represent all values that Ignite supports. This type fills the gap.
Option<T>

A wrapper that may or may not contain a value of type T.

Interfaces

IAuthenticator

Ignite client authenticator. Provides authentication information during server handshake.

IIgnite

Ignite API entry point.

All Ignite APIs are thread-safe, unless noted otherwise.

Implementation can be a thin client (see IIgniteClient and StartAsync(IgniteClientConfiguration)), or a direct IPC connection for server-side functionality like compute.
IIgniteClient

Ignite client. Extends IIgnite with client-specific functionality.

All Ignite APIs are thread-safe, unless noted otherwise.
IRetryPolicy

Client retry policy determines whether client operations that have failed due to a connection issue should be retried.

IRetryPolicyContext

Retry policy context. See ShouldRetry(IRetryPolicyContext).

ISslStreamFactory

SSL Stream Factory defines how SSL connection is established.

See SslStreamFactory, SslStreamFactory.

Enums

ClientOperationType

Client operation type.