Docs
You are looking at preliminary documentation for a future release. Not what you want? See the current release documentation.
Elasticsearch.Net and NEST: the .NET clients [master] » Client Concepts - Elasticsearch.Net » Lifetimes
«  Connecting     Post data  »

Lifetimesedit

If you are using an IOC container its always useful to know the best practices around the lifetime of your objects

In general we advise folks to register their ElasticClient instances as singletons. The client is thread safe so sharing an instance between threads is fine.

Zooming in however the actual moving part that benefits the most from being static for most of the duration of your application is ConnectionSettings; caches are per ConnectionSettings.

In some applications it could make perfect sense to have multiple singleton ElasticClient's registered with different connection settings. e.g if you have 2 functionally isolated Elasticsearch clusters.

Important

Due to the semantic versioning of Elasticsearch.Net and NEST and their alignment to versions of Elasticsearch, all instances of ElasticClient and Elasticsearch clusters that are connected to must be on the same major version i.e. it is not possible to have both an ElasticClient to connect to Elasticsearch 1.x and 2.x in the same application as the former would require NEST 1.x and the latter, NEST 2.x.

Let’s demonstrate which components are disposed by creating our own derived ConnectionSettings, IConnectionPool and IConnection types

class AConnectionSettings : ConnectionSettings
{
    public AConnectionSettings(IConnectionPool pool, IConnection connection)
        : base(pool, connection)
    { }
    public bool IsDisposed { get; private set; }
    protected override void DisposeManagedResources()
    {
        this.IsDisposed = true;
        base.DisposeManagedResources();
    }
}

class AConnectionPool : SingleNodeConnectionPool
{
    public AConnectionPool(Uri uri, IDateTimeProvider dateTimeProvider = null) : base(uri, dateTimeProvider) { }

    public bool IsDisposed { get; private set; }
    protected override void DisposeManagedResources()
    {
        this.IsDisposed = true;
        base.DisposeManagedResources();
    }
}

class AConnection : InMemoryConnection
{
    public bool IsDisposed { get; private set; }
    protected override void DisposeManagedResources()
    {
        this.IsDisposed = true;
        base.DisposeManagedResources();
    }
}

ConnectionSettings, IConnectionPool and IConnection all explictily implement IDisposable

var connection = new AConnection();
var connectionPool = new AConnectionPool(new Uri("http://localhost:9200"));
var settings = new AConnectionSettings(connectionPool, connection);
settings.IsDisposed.Should().BeFalse();
connectionPool.IsDisposed.Should().BeFalse();
connection.IsDisposed.Should().BeFalse();

Disposing ConnectionSettings will also dispose the IConnectionPool and IConnection it uses

var connection = new AConnection();

var connectionPool = new AConnectionPool(new Uri("http://localhost:9200"));

var settings = new AConnectionSettings(connectionPool, connection);

settings.IsDisposed.Should().BeTrue();

connectionPool.IsDisposed.Should().BeTrue();

connection.IsDisposed.Should().BeTrue();
«  Connecting     Post data  »