MySqlConnectionStringBuilder Class

Aids in the creation of connection strings by exposing the connection options as properties. Contains connection options specific to the Classic protocol.

Inheritance Hierarchy

SystemObject
  System.Data.CommonDbConnectionStringBuilder
    MySql.Data.MySqlClientMySqlBaseConnectionStringBuilder
      MySql.Data.MySqlClientMySqlConnectionStringBuilder

Namespace: MySql.Data.MySqlClient
Assembly: MySql.Data (in MySql.Data.dll) Version: 8.0.22

Syntax

Copy

public sealed class MySqlConnectionStringBuilder : MySqlBaseConnectionStringBuilder

Public NotInheritable Class MySqlConnectionStringBuilder
	Inherits MySqlBaseConnectionStringBuilder

The MySqlConnectionStringBuilder type exposes the following members.

Constructors

	Name	Description
	MySqlConnectionStringBuilder	Main constructor.
	MySqlConnectionStringBuilder(String)	Constructor accepting a connection string.

Top

Properties

	Name	Description
	AllowBatch	Gets or sets a boolean value that indicates whether this connection will allow commands to send multiple SQL statements in one execution.
	AllowLoadLocalInfile	Gets or sets a boolean value that indicates whether this connection will allow to load data local infile.
	AllowLoadLocalInfileInPath	Gets or sets the safe path where files can be read and uploaded to the server.
	AllowPublicKeyRetrieval	Gets or sets a boolean value that indicates if RSA public keys should be retrieved from the server.
	AllowUserVariables	Gets or sets a boolean value that indicates if the provider expects user variables in the SQL.
	AllowZeroDateTime	Gets or sets a boolean value that indicates if zero date time values are supported.
	AutoEnlist	Gets or sets a boolean value that indicates if an opened connection should particiapte in the current scope.
	BlobAsUTF8ExcludePattern	Gets or sets the pattern to match for the columns that should not be treated as UTF8.
	BlobAsUTF8IncludePattern	Gets or sets the pattern to match for the columns that should be treated as UTF8.
	BrowsableConnectionString	Gets or sets a value that indicates whether the ConnectionString property is visible in Visual Studio designers. (Inherited from DbConnectionStringBuilder.)
	CacheServerProperties	Gets or sets a boolean value that indicates whether the server variable settings are updated by a SHOW VARIABLES command each time a pooled connection is returned.
	CertificateFile	Gets or sets the path to the certificate file to be used. (Inherited from MySqlBaseConnectionStringBuilder.)
	CertificatePassword	Gets or sets the password to be used in conjunction with the certificate file. (Inherited from MySqlBaseConnectionStringBuilder.)
	CertificateStoreLocation	Gets or sets the location to a personal store where a certificate is held. (Inherited from MySqlBaseConnectionStringBuilder.)
	CertificateThumbprint	Gets or sets a certificate thumbprint to ensure correct identification of a certificate contained within a personal store. (Inherited from MySqlBaseConnectionStringBuilder.)
	CharacterSet	Gets or sets the character set that should be used for sending queries to the server. (Inherited from MySqlBaseConnectionStringBuilder.)
	CheckParameters	Gets or sets a boolean value that indicates if stored routine parameters should be checked against the server.
	CommandInterceptors	Gets or sets the list of interceptors that can intercept command operations.
	ConnectionLifeTime	Gets or sets the lifetime of a pooled connection.
	ConnectionProtocol	Gets or sets the protocol that should be used for communicating with MySQL. (Inherited from MySqlBaseConnectionStringBuilder.)
	ConnectionReset	Gets or sets a boolean value that indicates if the connection should be reset when retrieved from the pool.
	ConnectionString	Gets or sets the connection string associated with the DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder.)
	ConnectionTimeout	Gets or sets the connection timeout.
	ConvertZeroDateTime	Gets or sets a boolean value that indicates if zero datetime values should be converted to DateTime.MinValue.
	Count	Gets the current number of keys that are contained within the ConnectionString property. (Inherited from DbConnectionStringBuilder.)
	Database	Gets or sets the name of the database for the initial connection. (Inherited from MySqlBaseConnectionStringBuilder.)
	DefaultCommandTimeout	Gets or sets the default command timeout.
	DefaultTableCacheAge	Gets or sets the seconds for how long a TableDirect result should be cached.
	DnsSrv	Gets or sets a boolean value that indicates whether this connection should resolve DNS SRV records. (Inherited from MySqlBaseConnectionStringBuilder.)
	ExceptionInterceptors	Gets or sets the list of interceptors that can triage thrown MySqlExceptions.
	FunctionsReturnString	Gets or sets a boolean value that indicates if server functions should be treated as returning a string.
	IgnorePrepare	Gets or sets a boolean value that indicates if calls to the Prepare method should be ignored.
	IncludeSecurityAsserts	Gets or sets a boolean value that indicates if security asserts must be included.
	IntegratedSecurity	Gets or sets a boolean value that indicates if the connection should be encrypted.
	InteractiveSession	Gets or sets a boolean value that indicates if the session should be interactive.
	IsFixedSize	Gets a value that indicates whether the DbConnectionStringBuilder has a fixed size. (Inherited from DbConnectionStringBuilder.)
	IsReadOnly	Gets a value that indicates whether the DbConnectionStringBuilder is read-only. (Inherited from DbConnectionStringBuilder.)
	Item	Gets or sets a connection option. (Overrides DbConnectionStringBuilderItemString.)
	Keepalive	Gets or sets the idle connection time(seconds) for TCP connections. (Inherited from MySqlBaseConnectionStringBuilder.)
	Keys	Gets an ICollection that contains the keys in the DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder.)
	Logging	Gets or sets a boolean value that indicates whether logging is enabled.
	MaximumPoolSize	Gets or sets the maximum connection pool setting.
	MinimumPoolSize	Gets the minimum connection pool size.
	OldGuids	Gets or sets a boolean value that indicates if items of data type BINARY(16) should be treated as guids.
	Password	Gets or sets the password that should be used to make a connection. (Inherited from MySqlBaseConnectionStringBuilder.)
	PersistSecurityInfo	Gets or sets a boolean value that indicates if the password should be persisted in the connection string.
	PipeName	Gets or sets the name of the named pipe that should be used for communicating with MySQL.
	Pooling	Gets or sets a boolean value indicating if connection pooling is enabled.
	Port	Gets or sets the port number that is used when the socket protocol is being used. (Inherited from MySqlBaseConnectionStringBuilder.)
	ProcedureCacheSize	Gets or sets the size of the stored procedure cache.
	Replication	Gets or sets a boolean value that indicates if this connection will use replication.
	RespectBinaryFlags	Gets or sets a boolean value that indicates if column binary flags set by the server are ignored.
	Server	Gets or sets the name of the server. The aliases 'address', 'addr' and 'network address' are deprecated as valid server synonyms. (Inherited from MySqlBaseConnectionStringBuilder.)
	SharedMemoryName	Gets or sets the base name of the shared memory objects used to communicate with MySQL when the shared memory protocol is being used.
	SqlServerMode	Gets or sets a boolean value that indicates if SQL Server syntax should be allowed by supporting square brackets around symbols instead of backticks.
	SshHostName	Gets or sets the name of the SSH server. (Inherited from MySqlBaseConnectionStringBuilder.)
	SshKeyFile	Gets or sets the SSH key file to authenticate to the SSH server. (Inherited from MySqlBaseConnectionStringBuilder.)
	SshPassphrase	Gets or sets the passphrase of the key file to authenticate to the SSH server. (Inherited from MySqlBaseConnectionStringBuilder.)
	SshPassword	Gets or sets the password to authenticate to the SSH server. (Inherited from MySqlBaseConnectionStringBuilder.)
	SshPort	Gets or sets the port number to use when authenticating to the SSH server. (Inherited from MySqlBaseConnectionStringBuilder.)
	SshUserName	Gets or sets the user name to authenticate to the SSH server. (Inherited from MySqlBaseConnectionStringBuilder.)
	SslCa	(Inherited from MySqlBaseConnectionStringBuilder.)
	SslCert	Gets or sets the path to a local certificate file in PEM format to use for establishing an encrypted connection. (Inherited from MySqlBaseConnectionStringBuilder.)
	SslKey	Gets or sets the path to a local key file in PEM format to use for establishing an encrypted connection. (Inherited from MySqlBaseConnectionStringBuilder.)
	SslMode	Indicates whether to use SSL connections and how to handle server certificate errors. (Inherited from MySqlBaseConnectionStringBuilder.)
	TableCaching	Gets or sets a boolean value that indicates if caching of TableDirect commands is enabled.
	TlsVersion	Sets the TLS versions to use in a SSL connection to the server. (Inherited from MySqlBaseConnectionStringBuilder.)
	TreatBlobsAsUTF8	Indicates whether the driver should treat binary BLOBs as UTF8.
	TreatTinyAsBoolean	Gets or sets a boolean value that indicates if TINYINT(1) shound be treated as a BOOLEAN.
	UseAffectedRows	Gets or sets a boolean value that indicates if the server should report affected rows instead of found rows.
	UseCompression	Gets or sets a boolean value that indicates whether this connection should use compression.
	UseDefaultCommandTimeoutForEF
	UsePerformanceMonitor	Gets or sets a boolean value that indicates if the performance monitor hooks should be enabled.
	UserID	Gets or sets the user ID that should be used to connect with. (Inherited from MySqlBaseConnectionStringBuilder.)
	UseUsageAdvisor	Gets or sets a boolean value that indicates if the Usage Advisor should be enabled.
	Values	Gets an ICollection that contains the values in the DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder.)

Top

Methods

	Name	Description
	Add	Adds an entry with the specified key and value into the DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder.)
	Clear	(Overrides DbConnectionStringBuilderClear.)
	ClearPropertyDescriptors	Clears the collection of PropertyDescriptor objects on the associated DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder.)
	ContainsKey	(Overrides DbConnectionStringBuilderContainsKey(String).)
	Equals	(Overrides ObjectEquals(Object).)
	EquivalentTo	Compares the connection information in this DbConnectionStringBuilder object with the connection information in the supplied object. (Inherited from DbConnectionStringBuilder.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetConnectionString	(Inherited from MySqlBaseConnectionStringBuilder.)
	GetHashCode	(Inherited from MySqlBaseConnectionStringBuilder.)
	GetProperties	Fills a supplied Hashtable with information about all the properties of this DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	(Overrides DbConnectionStringBuilderRemove(String).)
	ShouldSerialize	Indicates whether the specified key exists in this DbConnectionStringBuilder instance. (Inherited from DbConnectionStringBuilder.)
	ToString	Returns the connection string associated with this DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder.)
	TryGetValue	Retrieves a value corresponding to the supplied key from this DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder.)

Top

Reference

MySql.Data.MySqlClient Namespace