Click or drag to resize

MySqlXConnectionStringBuilder Class

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

Namespace:  MySqlX.XDevAPI
Assembly:  MySql.Data (in MySql.Data.dll) Version: 8.0.22
Syntax
public sealed class MySqlXConnectionStringBuilder : MySqlBaseConnectionStringBuilder

The MySqlXConnectionStringBuilder type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAuth
Public propertyBrowsableConnectionString
Gets or sets a value that indicates whether the ConnectionString property is visible in Visual Studio designers.
(Inherited from DbConnectionStringBuilder.)
Public propertyCertificateFile
Gets or sets the path to the certificate file to be used.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyCertificatePassword
Gets or sets the password to be used in conjunction with the certificate file.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyCertificateStoreLocation
Gets or sets the location to a personal store where a certificate is held.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyCertificateThumbprint
Gets or sets a certificate thumbprint to ensure correct identification of a certificate contained within a personal store.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyCharacterSet
Gets or sets the character set that should be used for sending queries to the server.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyCompression
Gets or sets the compression type between client and server.
Public propertyCompressionAlgorithm
Gets or sets the compression algorithm.
Public propertyConnectionAttributes
Gets or sets the connection attributes.
Public propertyConnectionProtocol
Gets or sets the protocol that should be used for communicating with MySQL.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyConnectionString
Gets or sets the connection string associated with the DbConnectionStringBuilder.
(Inherited from DbConnectionStringBuilder.)
Public propertyConnectTimeout
Gets or sets the connection timeout.
Public propertyCount
Gets the current number of keys that are contained within the ConnectionString property.
(Inherited from DbConnectionStringBuilder.)
Public propertyDatabase
Gets or sets the name of the database for the initial connection.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyDnsSrv
Gets or sets a boolean value that indicates whether this connection should resolve DNS SRV records.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyIsFixedSize
Gets a value that indicates whether the DbConnectionStringBuilder has a fixed size.
(Inherited from DbConnectionStringBuilder.)
Public propertyIsReadOnly
Gets a value that indicates whether the DbConnectionStringBuilder is read-only.
(Inherited from DbConnectionStringBuilder.)
Public propertyItem
Gets or sets a connection option.
(Overrides DbConnectionStringBuilderItemString.)
Public propertyKeepalive
Gets or sets the idle connection time(seconds) for TCP connections.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyKeys
Gets an ICollection that contains the keys in the DbConnectionStringBuilder.
(Inherited from DbConnectionStringBuilder.)
Public propertyPassword
Gets or sets the password that should be used to make a connection.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyPort
Gets or sets the port number that is used when the socket protocol is being used.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyServer
Gets or sets the name of the server.

The aliases 'address', 'addr' and 'network address' are deprecated as valid server synonyms.

(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertySshHostName
Gets or sets the name of the SSH server.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertySshKeyFile
Gets or sets the SSH key file to authenticate to the SSH server.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertySshPassphrase
Gets or sets the passphrase of the key file to authenticate to the SSH server.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertySshPassword
Gets or sets the password to authenticate to the SSH server.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertySshPort
Gets or sets the port number to use when authenticating to the SSH server.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertySshUserName
Gets or sets the user name to authenticate to the SSH server.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertySslCa (Inherited from MySqlBaseConnectionStringBuilder.)
Public propertySslCert
Gets or sets the path to a local certificate file in PEM format to use for establishing an encrypted connection.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertySslCrl
Path to a local file containing certificate revocation lists.
Public propertySslKey
Gets or sets the path to a local key file in PEM format to use for establishing an encrypted connection.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertySslMode
Indicates whether to use SSL connections and how to handle server certificate errors.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyCode exampleTlsVersion
Sets the TLS versions to use in a SSL connection to the server.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyUserID
Gets or sets the user ID that should be used to connect with.
(Inherited from MySqlBaseConnectionStringBuilder.)
Public propertyValues
Gets an ICollection that contains the values in the DbConnectionStringBuilder.
(Inherited from DbConnectionStringBuilder.)
Top
Methods
  NameDescription
Public methodAdd
Adds an entry with the specified key and value into the DbConnectionStringBuilder.
(Inherited from DbConnectionStringBuilder.)
Public methodClear (Overrides DbConnectionStringBuilderClear.)
Protected methodClearPropertyDescriptors
Clears the collection of PropertyDescriptor objects on the associated DbConnectionStringBuilder.
(Inherited from DbConnectionStringBuilder.)
Public methodContainsKey (Overrides DbConnectionStringBuilderContainsKey(String).)
Public methodEquals (Overrides ObjectEquals(Object).)
Public methodEquivalentTo
Compares the connection information in this DbConnectionStringBuilder object with the connection information in the supplied object.
(Inherited from DbConnectionStringBuilder.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetConnectionString (Inherited from MySqlBaseConnectionStringBuilder.)
Public methodGetHashCode (Inherited from MySqlBaseConnectionStringBuilder.)
Protected methodGetProperties
Fills a supplied Hashtable with information about all the properties of this DbConnectionStringBuilder.
(Inherited from DbConnectionStringBuilder.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemove (Overrides DbConnectionStringBuilderRemove(String).)
Public methodShouldSerialize
Indicates whether the specified key exists in this DbConnectionStringBuilder instance.
(Inherited from DbConnectionStringBuilder.)
Public methodToString
Returns the connection string associated with this DbConnectionStringBuilder.
(Inherited from DbConnectionStringBuilder.)
Public methodTryGetValue
Retrieves a value corresponding to the supplied key from this DbConnectionStringBuilder.
(Inherited from DbConnectionStringBuilder.)
Top
See Also