Apache.Ignite 3.0.0-nightly20230332

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 6.0
This is a prerelease version of Apache.Ignite.
dotnet add package Apache.Ignite --version 3.0.0-nightly20230332
NuGet\Install-Package Apache.Ignite -Version 3.0.0-nightly20230332
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Apache.Ignite" Version="3.0.0-nightly20230332" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Apache.Ignite --version 3.0.0-nightly20230332
#r "nuget: Apache.Ignite, 3.0.0-nightly20230332"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Apache.Ignite as a Cake Addin
#addin nuget:?package=Apache.Ignite&version=3.0.0-nightly20230332&prerelease

// Install Apache.Ignite as a Cake Tool
#tool nuget:?package=Apache.Ignite&version=3.0.0-nightly20230332&prerelease

Apache Ignite 3 .NET Client

.NET client for Apache Ignite - a distributed database for high‑performance applications with in‑memory speed.

Key Features

  • Full support of all Ignite APIs: SQL, Transactions, Key/Value, Compute.
  • Connects to any number of Ignite nodes at the same time.
  • Partition awareness: sends key-based requests to the right node.
  • Load-balancing, failover, automatic reconnection and request retries.
  • Built-in LINQ provider for strongly-typed SQL queries.
  • Integrates with NodaTime to provide precise mapping to Ignite date/time types.
  • Logging and metrics.
  • High performance and fully asynchronous.

Getting Started

Below are a few examples of basic usage to get you started:

// Connect to the cluster.
var cfg = new IgniteClientConfiguration("");
IIgniteClient client = await IgniteClient.StartAsync(cfg);

// Start a read-only transaction.
await using var tx = await client.Transactions.BeginAsync(
    new TransactionOptions { ReadOnly = true });

// Get table by name.
ITable? table = await client.Tables.GetTableAsync("Person");

// Get a strongly-typed view of table data using Person record.
IRecordView<Person> view = table!.GetRecordView<Person>();

// Upsert a record with KV (NoSQL) API.
await view.UpsertAsync(tx, new Person(1, "John"));

// Query data with SQL.
await using var resultSet = await client.Sql.ExecuteAsync<Person>(
    tx, "SELECT * FROM Person");
List<Person> sqlResults = await resultSet.ToListAsync();

// Query data with LINQ.
List<string> names  = view.AsQueryable(tx)
    .OrderBy(person => person.Name)
    .Select(person => person.Name)

// Execute a distributed computation.
IList<IClusterNode> nodes = await client.GetClusterNodesAsync();
int wordCount = await client.Compute.ExecuteAsync<int>(
    nodes, "org.foo.bar.WordCountTask", "Hello, world!");

API Walkthrough


IgniteClientConfiguration is used to configure connections properties (endpoints, SSL), retry policy, logging, and timeouts.

var cfg = new IgniteClientConfiguration
    // Connect to multiple servers.
    Endpoints = { "server1:10800", "server2:10801" },

    // Enable TLS.
    SslStreamFactory = new SslStreamFactory
        SslClientAuthenticationOptions = new SslClientAuthenticationOptions
            // Allow self-signed certificates.
            RemoteCertificateValidationCallback = 
                (sender, certificate, chain, errors) => true
    // Retry all read operations in case of network issues.
    RetryPolicy = new RetryReadPolicy { RetryLimit = 32 },

    // Log to console.
    Logger = new ConsoleLogger { MinLevel = LogLevel.Debug }


SQL is the primary API for data access. It is used to create, drop, and query tables, as well as to insert, update, and delete data.

using var client = await IgniteClient.StartAsync(new("localhost"));

await client.Sql.ExecuteAsync(
    null, "CREATE TABLE Person (Id INT PRIMARY KEY, Name VARCHAR)");

await client.Sql.ExecuteAsync(
    null, "INSERT INTO Person (Id, Name) VALUES (1, 'John Doe')");

await using var resultSet = await client.Sql.ExecuteAsync(
    null, "SELECT Name FROM Person");

await foreach (IIgniteTuple row in resultSet)

Mapping SQL Results to User Types

SQL results can be mapped to user types using ExecuteAsync<T> method. This is cleaner and more efficient than IIgniteTuple approach above.

await using var resultSet = await client.Sql.ExecuteAsync<Person>(
    null, "SELECT Name FROM Person");
await foreach (Person p in resultSet)
public record Person(int Id, string Name);

Column names are matched to record properties by name. To map columns to properties with different names, use ColumnAttribute.

DbDataReader (ADO.NET API)

Another way to work with query results is System.Data.Common.DbDataReader, which can be obtained with ExecuteReaderAsync method.

For example, you can bind query results to a DataGridView control:

await using var reader = await Client.Sql.ExecuteReaderAsync(
    null, "select * from Person");

var dt = new DataTable();

dataGridView1.DataSource = dt;


NoSQL API is used to store and retrieve data in a key/value fashion. It can be more efficient than SQL in certain scenarios. Existing tables can be accessed, but new tables can only be created with SQL.

First, get a table by name:

ITable? table = await client.Tables.GetTableAsync("Person");

Then, there are two ways to look at the data.

Record View

Record view represents the entire row as a single object. It can be an IIgniteTuple or a user-defined type.

IRecordView<IIgniteTuple> binaryView = table.RecordBinaryView;
IRecordView<Person> view = table.GetRecordView<Person>();

await view.UpsertAsync(null, new Person(1, "John"));

KeyValue View

Key/Value view splits the row into key and value parts.

IKeyValueView<IIgniteTuple, IIgniteTuple> kvBinaryView = table.KeyValueBinaryView;
IKeyValueView<PersonKey, Person> kvView = table.GetKeyValueView<PersonKey, Person>();

await kvView.PutAsync(null, new PersonKey(1), new Person("John"));


Data can be queried and modified with LINQ using AsQueryable method. LINQ expressions are translated to SQL queries and executed on the server.

ITable? table = await client.Tables.GetTableAsync("Person");
IRecordView<Person> view = table!.GetRecordView<Person>();

IQueryable<string> query = view.AsQueryable()
    .Where(p => p.Id > 100)
    .Select(p => p.Name);

List<string> names = await query.ToListAsync();

Generated SQL can be retrieved with ToQueryString extension method, or by enabling debug logging.

Bulk update and delete with optional conditions are supported via ExecuteUpdateAsync and ExecuteDeleteAsync extensions methods on IQueryable<T>


All operations on data in Ignite are transactional. If a transaction is not specified, an explicit transaction is started and committed automatically.

To start a transaction, use ITransactions.BeginAsync method. Then, pass the transaction object to all operations that should be part of the same transaction.

ITransaction tx = await client.Transactions.BeginAsync();

await view.UpsertAsync(tx, new Person(1, "John"));

await client.Sql.ExecuteAsync(
    tx, "INSERT INTO Person (Id, Name) VALUES (2, 'Jane')");

await view.AsQueryable(tx)
    .Where(p => p.Id > 0)
    .ExecuteUpdateAsync(p => new Person(p.Id, p.Name + " Doe"));

await tx.CommitAsync();


Compute API is used to execute distributed computations on the cluster. Compute jobs should be implemented in Java, deployed to server nodes, and called by the full class name.

IList<IClusterNode> nodes = await client.GetClusterNodesAsync();
string result = await client.Compute.ExecuteAsync<string>(
    nodes, "org.acme.tasks.MyTask", "Task argument 1", "Task argument 2");

Failover, Retry, Reconnect, Load Balancing

Ignite client implements a number of features to improve reliability and performance:

  • When multiple endpoints are configured, the client will maintain connections to all of them, and load balance requests between them.
  • If a connection is lost, the client will try to reconnect, assuming it may be a temporary network issue or a node restart.
  • Periodic heartbeat messages are used to detect connection issues early.
  • If a user request fails due to a connection issue, the client will retry it automatically according to the configured IgniteClientConfiguration.RetryPolicy.


To enable logging, set IgniteClientConfiguration.Logger property. ConsoleLogger is provided out of the box. Other loggers can be integrated by implementing IIgniteLogger interface.


Ignite client exposes a number of metrics with Apache.Ignite meter name through the System.Diagnostics.Metrics API that can be used to monitor system health and performance.

For example, dotnet-counters tool can be used like this:

dotnet-counters monitor --counters Apache.Ignite,System.Runtime --process-id PID


Full documentation is available at https://ignite.apache.org/docs.


Use any of the following channels to provide feedback:

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (9)

Showing the top 5 NuGet packages that depend on Apache.Ignite:

Package Downloads
Apache.Ignite.Linq The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Apache Ignite LINQ Provider. Query distributed in-memory data in a strongly-typed manner and with IDE support. All Ignite SQL features are supported: distributed joins, groupings, aggregates, field queries, and more.

Apache.Ignite.NLog The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Apache Ignite NLog Logger.

Apache.Ignite.Log4Net The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Apache Ignite log4net Logger.

Apache.Ignite.EntityFramework The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Apache Ignite EntityFramework Second Level Cache: caches EF query results in a distributed in-memory cache.


Contains dlls of Ignite Persistence Provider: IgniteProvider which implements interfaces: IPersistenceProvider, ISchemePersistenceProvider and IWorkflowGenerator. Steps for workflow runtime configuration with IgniteProvider: http://workflowenginenet.com/Documentation/Detail/howtoconnect in Create WorkflowRuntime section.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.0-nightly20230332 215 3/31/2023
3.0.0-nightly20230331 186 3/31/2023
3.0.0-nightly20230124 233 1/24/2023
3.0.0-beta1 221 11/17/2022
3.0.0-alpha3 425 10/17/2021
2.15.0 18,584 5/4/2023
2.15.0-alpha20221117 351 11/17/2022
2.14.0 55,080 10/7/2022 447 10/25/2021
2.13.0 50,612 4/26/2022
2.12.0 57,190 1/15/2022
2.11.1 21,163 12/21/2021
2.11.0 8,863 9/18/2021
2.11.0-alpha20210225 6,310 2/25/2021
2.11.0-alpha20210212 437 2/12/2021
2.11.0-alpha20210211 436 2/11/2021
2.11.0-alpha20210205 509 2/5/2021
2.11.0-alpha20210120 586 1/20/2021
2.10.0 75,092 3/16/2021
2.9.1 37,075 12/28/2020
2.9.0 43,049 10/22/2020
2.9.0-alpha20201001 667 10/1/2020
2.9.0-alpha20200710 894 7/10/2020
2.9.0-alpha20200403 1,270 4/3/2020
2.8.1 99,455 5/27/2020
2.8.0 42,262 3/4/2020
2.8.0-alpha20200122 1,341 1/22/2020
2.8.0-alpha20200109 1,067 1/9/2020
2.8.0-alpha20200108 989 1/8/2020
2.8.0-alpha20191218 1,338 12/18/2019
2.8.0-alpha20191203 856 12/3/2019
2.8.0-alpha20191118 964 11/17/2019
2.7.6 22,723 9/20/2019
2.7.5 22,949 6/18/2019
2.7.0 94,432 12/8/2018
2.6.0 153,911 7/18/2018
2.5.0 7,236 5/29/2018
2.4.0 23,565 3/12/2018
2.3.0 4,824 10/31/2017
2.2.0 4,142 9/19/2017
2.1.0 6,856 7/28/2017
2.0.0 3,034 5/3/2017
1.9.0 2,896 3/6/2017
1.8.0 3,020 12/8/2016
1.7.0 6,541 8/5/2016
1.6.0 2,416 5/23/2016