Search Results for

    Show / Hide Table of Contents

    Class MySqlXConnectionStringBuilder

    Enables the creation of connection strings by exposing the connection options as properties. Contains connection options specific to the X protocol.

    Inheritance
    System.Object
    System.Data.Common.DbConnectionStringBuilder
    MySqlBaseConnectionStringBuilder
    MySqlXConnectionStringBuilder
    Implements
    System.Collections.IDictionary
    System.Collections.ICollection
    System.Collections.IEnumerable
    System.ComponentModel.ICustomTypeDescriptor
    Namespace: MySqlX.XDevAPI
    Assembly: MySql.Data.dll
    Version: 9.3.0
    Syntax
    public sealed class MySqlXConnectionStringBuilder : MySqlBaseConnectionStringBuilder, IDictionary, ICollection, IEnumerable, ICustomTypeDescriptor

    Constructors

    MySqlXConnectionStringBuilder()

    Main constructor.

    Declaration
    public MySqlXConnectionStringBuilder()

    MySqlXConnectionStringBuilder(String, Boolean)

    Constructor accepting a connection string.

    Declaration
    public MySqlXConnectionStringBuilder(string connectionString, bool isDefaultPort = true)
    Parameters
    Type Name Description
    System.String connectionString

    The connection string.

    System.Boolean isDefaultPort

    A flag indicating if the default port is used in the connection.

    Properties

    Auth

    Declaration
    public MySqlAuthenticationMode Auth { get; set; }
    Property Value
    Type Description
    MySqlAuthenticationMode

    Compression

    Gets or sets the compression type between client and server.

    Declaration
    public CompressionType Compression { get; set; }
    Property Value
    Type Description
    CompressionType

    CompressionAlgorithm

    Gets or sets the compression algorithm.

    Declaration
    public string CompressionAlgorithm { get; set; }
    Property Value
    Type Description
    System.String

    ConnectionAttributes

    Gets or sets the connection attributes.

    Declaration
    public string ConnectionAttributes { get; set; }
    Property Value
    Type Description
    System.String

    ConnectTimeout

    Gets or sets the connection timeout.

    Declaration
    public uint ConnectTimeout { get; set; }
    Property Value
    Type Description
    System.UInt32

    Item[String]

    Gets or sets a connection option.

    Declaration
    public override object this[string keyword] { get; set; }
    Parameters
    Type Name Description
    System.String keyword

    The keyword that identifies the connection option to modify.

    Property Value
    Type Description
    System.Object
    Overrides
    System.Data.Common.DbConnectionStringBuilder.Item[System.String]

    SslCrl

    Path to a local file containing certificate revocation lists.

    Declaration
    public string SslCrl { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    Clear()

    Declaration
    public override void Clear()
    Overrides
    System.Data.Common.DbConnectionStringBuilder.Clear()

    ContainsKey(String)

    Declaration
    public override bool ContainsKey(string keyword)
    Parameters
    Type Name Description
    System.String keyword
    Returns
    Type Description
    System.Boolean
    Overrides
    System.Data.Common.DbConnectionStringBuilder.ContainsKey(System.String)

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean
    Overrides
    System.Object.Equals(System.Object)

    Remove(String)

    Declaration
    public override bool Remove(string keyword)
    Parameters
    Type Name Description
    System.String keyword
    Returns
    Type Description
    System.Boolean
    Overrides
    System.Data.Common.DbConnectionStringBuilder.Remove(System.String)

    TryGetValue(String, out Object)

    Retrieves the value corresponding to the supplied key from this MySqlXConnectionStringBuilder.

    Declaration
    public override bool TryGetValue(string keyword, out object value)
    Parameters
    Type Name Description
    System.String keyword

    The key of the item to retrieve.

    System.Object value

    The value corresponding to the keyword.

    Returns
    Type Description
    System.Boolean

    true if keyword was found within the connection string; otherwise, false.

    Overrides
    MySqlBaseConnectionStringBuilder.TryGetValue(String, out Object)
    Exceptions
    Type Condition
    System.ArgumentNullException

    keyword contains a null value.

    Implements

    System.Collections.IDictionary
    System.Collections.ICollection
    System.Collections.IEnumerable
    System.ComponentModel.ICustomTypeDescriptor
    In This Article
    • Constructors
      • MySqlXConnectionStringBuilder()
      • MySqlXConnectionStringBuilder(String, Boolean)
    • Properties
      • Auth
      • Compression
      • CompressionAlgorithm
      • ConnectionAttributes
      • ConnectTimeout
      • Item[String]
      • SslCrl
    • Methods
      • Clear()
      • ContainsKey(String)
      • Equals(Object)
      • Remove(String)
      • TryGetValue(String, out Object)
    • Implements
    Back to top Copyright © 2021, 2025, Oracle and/or its affiliates.