DotNET client usage

Chronicle uses connection strings to configure the .NET client. You can pass a connection string to ChronicleOptions or provide one when constructing a ChronicleClient.

Development defaults

The ChronicleConnectionString.Development constant provides a pre-configured development connection string. Default constructors also use this value:

C#

public static class ConnectionStringsDevelopmentDefaults
{
    public static ChronicleClient Create()
    {
        var options = new ChronicleOptions();
        return new ChronicleClient(options);
    }
}

This is equivalent to:

C#

using Cratis.Chronicle.Connections;

public static class ConnectionStringsDevelopmentDefaultsEquivalent
{
    public static ChronicleClient CreateFromOptions()
    {
        var options = ChronicleOptions.FromDevelopmentConnectionString();
        return new ChronicleClient(options);
    }

    public static ChronicleClient CreateFromConnectionString() => new(ChronicleConnectionString.Development);
}

Note

In development, you can use chronicle://localhost:35000 without credentials. The .NET client automatically attempts the built-in development credentials (chronicle-dev-client / chronicle-dev-secret).

Use explicit configuration for production environments.

From connection string

C#

public static class ConnectionStringsFromConnectionString
{
    public static ChronicleClient Create()
    {
        var options = ChronicleOptions.FromConnectionString("chronicle://localhost:35000");
        return new ChronicleClient(options);
    }
}

Fluent builder

Use ChronicleConnectionStringBuilder to construct a connection string programmatically:

C#

using Cratis.Chronicle.Connections;

public static class ConnectionStringsFluentBuilder
{
    public static ChronicleClient Create()
    {
        var connectionString = new ChronicleConnectionStringBuilder()
            .WithHost("server.example.com")
            .WithPort(35000)
            .WithCredentials("clientId", "clientSecret")
            .Build();

        var options = ChronicleOptions.FromConnectionString(connectionString);
        return new ChronicleClient(options);
    }
}

Authentication validation

You cannot specify both client credentials and API key authentication in the same connection string. Doing so throws an AmbiguousAuthenticationMode error.