Class IgniteDbConnectionStringBuilder

Namespace

Apache.Ignite.Sql

Assembly

Apache.Ignite.dll

Ignite connection string builder.

public sealed class IgniteDbConnectionStringBuilder : DbConnectionStringBuilder, IDictionary, ICollection, IEnumerable, ICustomTypeDescriptor

Inheritance

object

DbConnectionStringBuilder

IgniteDbConnectionStringBuilder

Implements

IDictionary

ICollection

IEnumerable

ICustomTypeDescriptor

Inherited Members

DbConnectionStringBuilder.Add(string, object)

DbConnectionStringBuilder.AppendKeyValuePair(StringBuilder, string, string)

DbConnectionStringBuilder.AppendKeyValuePair(StringBuilder, string, string, bool)

DbConnectionStringBuilder.Clear()

DbConnectionStringBuilder.ContainsKey(string)

DbConnectionStringBuilder.EquivalentTo(DbConnectionStringBuilder)

DbConnectionStringBuilder.Remove(string)

DbConnectionStringBuilder.ShouldSerialize(string)

DbConnectionStringBuilder.ToString()

DbConnectionStringBuilder.TryGetValue(string, out object)

DbConnectionStringBuilder.ConnectionString

DbConnectionStringBuilder.Count

DbConnectionStringBuilder.IsFixedSize

DbConnectionStringBuilder.IsReadOnly

DbConnectionStringBuilder.Keys

DbConnectionStringBuilder.Values

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Constructors

IgniteDbConnectionStringBuilder()

Initializes a new instance of the IgniteDbConnectionStringBuilder class.

public IgniteDbConnectionStringBuilder()

IgniteDbConnectionStringBuilder(string)

Initializes a new instance of the IgniteDbConnectionStringBuilder class.

public IgniteDbConnectionStringBuilder(string connectionString)

Parameters

connectionString string

Connection string.

Fields

EndpointSeparator

Gets the character used to separate multiple endpoints in the connection string.

public const char EndpointSeparator = ','

Field Value

char

Properties

Endpoints

Gets or sets the Ignite endpoints. Multiple endpoints can be specified separated by comma, e.g. "localhost:10800,localhost:10801". If the port is not specified, the default port 10800 is used.

public IList<string> Endpoints { get; set; }

Property Value

IList<string>

HeartbeatInterval

Gets or sets the heartbeat interval. See HeartbeatInterval for more details.

public TimeSpan HeartbeatInterval { get; set; }

Property Value

TimeSpan

this[string]

Gets or sets the value associated with the specified key.

public override object this[string keyword] { get; set; }

Parameters

keyword string

The key of the item to get or set.

Property Value

object

The value associated with the specified key. If the specified key is not found, trying to get it returns a null reference (Nothing in Visual Basic), and trying to set it creates a new element using the specified key.

Passing a null (Nothing in Visual Basic) key throws an ArgumentNullException. Assigning a null value removes the key/value pair.

Exceptions

ArgumentNullException

keyword is a null reference (Nothing in Visual Basic).

NotSupportedException

The property is set, and the DbConnectionStringBuilder is read-only.

-or-

The property is set, keyword does not exist in the collection, and the DbConnectionStringBuilder has a fixed size.

OperationTimeout

Gets or sets the socket timeout. See OperationTimeout for more details.

public TimeSpan OperationTimeout { get; set; }

Property Value

TimeSpan

Password

Gets or sets the password for authentication.

public string? Password { get; set; }

Property Value

string

ReconnectInterval

Gets or sets the reconnect interval. See ReconnectInterval for more details.

public TimeSpan ReconnectInterval { get; set; }

Property Value

TimeSpan

SocketTimeout

Gets or sets the socket timeout. See SocketTimeout for more details.

public TimeSpan SocketTimeout { get; set; }

Property Value

TimeSpan

SslEnabled

Gets or sets a value indicating whether SSL is enabled.

public bool SslEnabled { get; set; }

Property Value

bool

Username

Gets or sets the username for authentication.

public string? Username { get; set; }

Property Value

string

Methods

ToIgniteClientConfiguration()

Converts this instance to IgniteClientConfiguration.

public IgniteClientConfiguration ToIgniteClientConfiguration()

Returns

IgniteClientConfiguration

Ignite client configuration.