/// <summary>
/// Initializes a new instance of the BaseSession class based on the specified connection string.
/// </summary>
/// <param name="connectionString">The connection used to create the session.</param>
/// <exception cref="ArgumentNullException"><paramref name="connectionString"/> is <c>null</c>.</exception>
/// <exception cref="UriFormatException">Unable to parse the <paramref name="connectionString"/> when
/// in URI format.</exception>
/// <remarks>
/// <para>When using Unix sockets the <c>protocol=unix</c> or <c>protocol=unixsocket</c> connection option is required.
/// This will enable elements passed in the <c>server</c> connection option to be treated as Unix sockets. The user is also required
/// to explicitly set <c>sslmode</c> to <c>none</c> since X Plugin does not support SSL when using Unix sockets. Note that
/// <c>protocol=unix</c> and <c>protocol=unixsocket</c> are synonyms.</para>
/// <para> </para>
/// <para>Multiple hosts can be specified as part of the <paramref name="connectionString"/>,
/// which enables client-side failover when trying to establish a connection.</para>
/// <para> </para>
/// <para>Connection URI examples:
/// <para />- mysqlx://test:test@[192.1.10.10,localhost]
/// <para />- mysqlx://test:test@[192.1.10.10,127.0.0.1]
/// <para />- mysqlx://root:@[../tmp/mysqlx.sock,/tmp/mysqld.sock]?protocol=unix&sslmode=none
/// <para />- mysqlx://test:test@[192.1.10.10:33060,127.0.0.1:33060]
/// <para />- mysqlx://test:test@[192.1.10.10,120.0.0.2:22000,[::1]:33060]/test?connectiontimeout=10
/// <para />- mysqlx://test:test@[(address=server.example,priority=20),(address=127.0.0.1,priority=100)]
/// <para />- mysqlx://test:test@[(address=server.example,priority=100),(address=127.0.0.1,priority=75),(address=192.0.10.56,priority=25)]
/// </para>
/// <para> </para>
/// <para>Connection string examples:
/// <para />- server=10.10.10.10,localhost;port=33060;uid=test;password=test;
/// <para />- host=10.10.10.10,192.101.10.2,localhost;port=5202;uid=test;password=test;
/// <para />- host=./tmp/mysqld.sock,/var/run/mysqldx.sock;port=5202;uid=root;protocol=unix;sslmode=none;
/// <para />- server=(address=server.example,priority=20),(address=127.0.0.1,priority=100);port=33060;uid=test;password=test;
/// <para />- server=(address=server.example,priority=100),(address=127.0.0.1,priority=75),(address=192.0.10.56,priority=25);port=33060;uid=test;password=test;
/// </para>
/// <para> </para>
/// <para>Failover methods</para>
/// <para>- Sequential: Connection attempts will be performed in a sequential order, that is, one after another until
/// a connection is successful or all the elements from the list have been tried.
/// </para>
/// <para>- Priority based: If a priority is provided, the connection attemps will be performed in descending order, starting
/// with the host with the highest priority. Priority must be a value between 0 and 100. Additionally, it is required to either
/// give a priority for every host or no priority to any host.
/// </para>
/// </remarks>
internal BaseSession(string connectionString, Client client = null) : this()
{
if (string.IsNullOrWhiteSpace(connectionString))
{
throw new ArgumentNullException("connectionString");
}
_client = client;
this._connectionString = ParseConnectionData(connectionString);
// Multiple hosts were specified.
if (FailoverManager.FailoverGroup != null)
{
_internalSession = FailoverManager.AttemptConnection(this._connectionString, out this._connectionString);
Settings.ConnectionString = this._connectionString;
Settings.AnalyzeConnectionString(this._connectionString, true);
}
// A single host was specified.
else
{
Settings.ConnectionString = _connectionString;
if (!(_connectionString.Contains("sslmode") || _connectionString.Contains("ssl mode") || _connectionString.Contains("ssl-mode")))
{
Settings.SslMode = MySqlSslMode.Required;
}
Settings.AnalyzeConnectionString(this._connectionString, true);
_internalSession = InternalSession.GetSession(Settings);
}
// Set the default schema if provided by the user.
if (!string.IsNullOrWhiteSpace(Settings.Database))
{
DefaultSchema = GetSchema(Settings.Database);
}
}
/// <summary>
/// Initializes a new instance of the BaseSession class based on the specified connection string.
/// </summary>
/// <param name="connectionString">The connection used to create the session.</param>
/// <exception cref="ArgumentNullException"><paramref name="connectionString"/> is <c>null</c>.</exception>
/// <exception cref="UriFormatException">Unable to parse the <paramref name="connectionString"/> when
/// in URI format.</exception>
/// <remarks>
/// <para>When using Unix sockets the <c>protocol=unix</c> or <c>protocol=unixsocket</c> connection option is required.
/// This will enable elements passed in the <c>server</c> connection option to be treated as Unix sockets. The user is also required
/// to explicitly set <c>sslmode</c> to <c>none</c> since X Plugin does not support SSL when using Unix sockets. Note that
/// <c>protocol=unix</c> and <c>protocol=unixsocket</c> are synonyms.</para>
/// <para> </para>
/// <para>Multiple hosts can be specified as part of the <paramref name="connectionString"/>,
/// which will enable client side failover when trying to establish a connection.</para>
/// <para> </para>
/// <para>Connection string examples (in URI format):
/// <para />- mysqlx://test:test@[192.1.10.10,localhost]
/// <para />- mysqlx://test:test@[192.1.10.10,127.0.0.1]
/// <para />- mysqlx://root:@[../tmp/mysqlx.sock,/tmp/mysqld.sock]?protocol=unix&sslmode=none
/// <para />- mysqlx://test:test@[192.1.10.10:33060,127.0.0.1:33060]
/// <para />- mysqlx://test:test@[192.1.10.10,120.0.0.2:22000,[::1]:33060]/test?connectiontimeout=10
/// <para />- mysqlx://test:test@[(address=server.example,priority=20),(address=127.0.0.1,priority=100)]
/// <para />- mysqlx://test:test@[(address=server.example,priority=100),(address=127.0.0.1,priority=75),(address=192.0.10.56,priority=25)]
/// </para>
/// <para> </para>
/// <para>Connection string examples (in basic format):
/// <para />- server=10.10.10.10,localhost;port=33060;uid=test;password=test;
/// <para />- host=10.10.10.10,192.101.10.2,localhost;port=5202;uid=test;password=test;
/// <para />- host=./tmp/mysqld.sock,/var/run/mysqldx.sock;port=5202;uid=root;protocol=unix;sslmode=none;
/// <para />- server=(address=server.example,priority=20),(address=127.0.0.1,priority=100);port=33060;uid=test;password=test;
/// <para />- server=(address=server.example,priority=100),(address=127.0.0.1,priority=75),(address=192.0.10.56,priority=25);port=33060;uid=test;password=test;
/// </para>
/// <para> </para>
/// <para>Failover methods</para>
/// <para>- Sequential: Connection attempts will be performed in a sequential order, that is, one after another until
/// a connection is successful or all the elements from the list have been tried.
/// </para>
/// <para>- Priority based: If a priority is provided, the connection attemps will be performed in descending order, starting
/// with the host with the highest priority. Priority must be a value between 0 and 100. Additionally, it is required to either
/// give a priority for every host or no priority to any host.
/// </para>
/// </remarks>
public BaseSession(string connectionString)
{
if (string.IsNullOrWhiteSpace(connectionString))
{
throw new ArgumentNullException("connectionString");
}
this.connectionString = ParseConnectionString(connectionString);
if (FailoverManager.FailoverGroup != null)
{
// Multiple hosts were specified.
_internalSession = FailoverManager.AttemptConnection(this.connectionString, out this.connectionString);
Settings = new MySqlConnectionStringBuilder(this.connectionString);
}
else
{
// A single host was specified.
Settings = new MySqlConnectionStringBuilder(this.connectionString);
_internalSession = InternalSession.GetSession(Settings);
}
if (!string.IsNullOrWhiteSpace(Settings.Database))
{
GetSchema(Settings.Database);
}
}
/// <summary>
/// Initializes a new instance of the BaseSession class based on the specified anonymous type object.
/// </summary>
/// <param name="connectionData">The connection data as an anonymous type used to create the session.</param>
/// <exception cref="ArgumentNullException"><paramref name="connectionData"/> is null.</exception>
/// <remarks>
/// <para>Multiple hosts can be specified as part of the <paramref name="connectionData"/>, which will enable client-side failover when trying to
/// establish a connection.</para>
/// <para> </para>
/// <para>To assign multiple hosts create a property similar to the connection string examples (in basic format) shown in
/// <see cref="BaseSession(string)"/>. Note that the value of the property must be a string.
/// </para>
/// </remarks>
public BaseSession(object connectionData)
{
if (connectionData == null)
{
throw new ArgumentNullException("connectionData");
}
var values = Tools.GetDictionaryFromAnonymous(connectionData);
if (!values.Keys.Any(s => s.ToLowerInvariant() == "port"))
{
values.Add("port", newDefaultPort);
}
Settings = new MySqlConnectionStringBuilder();
bool hostsParsed = false;
foreach (var value in values)
{
if (!Settings.ContainsKey(value.Key))
{
throw new KeyNotFoundException(string.Format(ResourcesX.InvalidConnectionStringAttribute, value.Key));
}
Settings.SetValue(value.Key, value.Value);
if (!hostsParsed && !string.IsNullOrEmpty(Settings["server"].ToString()))
{
var server = value.Value.ToString();
if (IsUnixSocket(server))
{
Settings.SetValue(value.Key, server = NormalizeUnixSocket(server));
}
ParseHostList(server, false);
if (FailoverManager.FailoverGroup != null)
{
Settings["server"] = FailoverManager.FailoverGroup.ActiveHost.Host;
}
hostsParsed = true;
}
}
this.connectionString = Settings.ToString();
if (FailoverManager.FailoverGroup != null)
{
// Multiple hosts were specified.
_internalSession = FailoverManager.AttemptConnection(this.connectionString, out this.connectionString);
Settings = new MySqlConnectionStringBuilder(this.connectionString);
}
else
{
_internalSession = InternalSession.GetSession(Settings);
}
if (!string.IsNullOrWhiteSpace(Settings.Database))
{
GetSchema(Settings.Database);
}
}
/// <summary>
/// Initializes a new instance of the BaseSession class based on the specified anonymous type object.
/// </summary>
/// <param name="connectionData">The connection data as an anonymous type used to create the session.</param>
/// <exception cref="ArgumentNullException"><paramref name="connectionData"/> is null.</exception>
/// <remarks>
/// <para>Multiple hosts can be specified as part of the <paramref name="connectionData"/>, which enables client-side failover when trying to
/// establish a connection.</para>
/// <para> </para>
/// <para>To assign multiple hosts, create a property similar to the connection string examples shown in
/// <see cref="BaseSession(string)"/>. Note that the value of the property must be a string.
/// </para>
/// </remarks>
internal BaseSession(object connectionData, Client client = null) : this()
{
if (connectionData == null)
{
throw new ArgumentNullException("connectionData");
}
_client = client;
var values = Tools.GetDictionaryFromAnonymous(connectionData);
if (!values.Keys.Any(s => s.ToLowerInvariant() == PORT_CONNECTION_OPTION_KEYWORD))
{
values.Add(PORT_CONNECTION_OPTION_KEYWORD, X_PROTOCOL_DEFAULT_PORT);
}
bool hostsParsed = false;
foreach (var value in values)
{
if (!Settings.ContainsKey(value.Key))
{
throw new KeyNotFoundException(string.Format(ResourcesX.InvalidConnectionStringAttribute, value.Key));
}
Settings.SetValue(value.Key, value.Value);
if (!hostsParsed && !string.IsNullOrEmpty(Settings[SERVER_CONNECTION_OPTION_KEYWORD].ToString()))
{
var server = value.Value.ToString();
if (IsUnixSocket(server))
{
Settings.SetValue(value.Key, server = NormalizeUnixSocket(server));
}
ParseHostList(server, false);
if (FailoverManager.FailoverGroup != null)
{
Settings[SERVER_CONNECTION_OPTION_KEYWORD] = null;
}
hostsParsed = true;
}
}
this._connectionString = Settings.ToString();
Settings.AnalyzeConnectionString(this._connectionString, true);
if (FailoverManager.FailoverGroup != null)
{
// Multiple hosts were specified.
_internalSession = FailoverManager.AttemptConnection(this._connectionString, out this._connectionString);
Settings.ConnectionString = _connectionString;
}
else
{
_internalSession = InternalSession.GetSession(Settings);
}
if (!string.IsNullOrWhiteSpace(Settings.Database))
{
DefaultSchema = GetSchema(Settings.Database);
}
}
/// <include file='docs/MySqlConnection.xml' path='docs/Open/*'/>
public override void Open()
{
if (State == ConnectionState.Open)
{
Throw(new InvalidOperationException(Resources.ConnectionAlreadyOpen));
}
// start up our interceptors
_exceptionInterceptor = new ExceptionInterceptor(this);
commandInterceptor = new CommandInterceptor(this);
SetState(ConnectionState.Connecting, true);
AssertPermissions();
//TODO: SUPPORT FOR 452 AND 46X
// if we are auto enlisting in a current transaction, then we will be
// treating the connection as pooled
if (Settings.AutoEnlist && Transaction.Current != null)
{
driver = DriverTransactionManager.GetDriverInTransaction(Transaction.Current);
if (driver != null &&
(driver.IsInActiveUse ||
!driver.Settings.EquivalentTo(this.Settings)))
{
Throw(new NotSupportedException(Resources.MultipleConnectionsInTransactionNotSupported));
}
}
MySqlConnectionStringBuilder currentSettings = Settings;
try
{
if (Settings.ConnectionProtocol == MySqlConnectionProtocol.Tcp && Settings.IsSshEnabled())
{
_sshHandler = new Ssh(
Settings.SshHostName,
Settings.SshUserName,
Settings.SshPassword,
Settings.SshKeyFile,
Settings.SshPassphrase,
Settings.SshPort,
Settings.Server,
Settings.Port,
false
);
_sshHandler.StartClient();
}
if (!Settings.Pooling || MySqlPoolManager.Hosts == null)
{
FailoverManager.Reset();
if (Settings.DnsSrv)
{
var dnsSrvRecords = DnsResolver.GetDnsSrvRecords(Settings.Server);
FailoverManager.SetHostList(dnsSrvRecords.ConvertAll(r => new FailoverServer(r.Target, r.Port, null)),
FailoverMethod.Sequential);
}
else
{
FailoverManager.ParseHostList(Settings.Server, false);
}
}
// Load balancing && Failover
if (ReplicationManager.IsReplicationGroup(Settings.Server))
{
if (driver == null)
{
ReplicationManager.GetNewConnection(Settings.Server, false, this);
}
else
{
currentSettings = driver.Settings;
}
}
else if (FailoverManager.FailoverGroup != null && !Settings.Pooling)
{
FailoverManager.AttemptConnection(this, Settings.ConnectionString, out string connectionString);
currentSettings.ConnectionString = connectionString;
}
if (Settings.Pooling)
{
if (FailoverManager.FailoverGroup != null)
{
FailoverManager.AttemptConnection(this, Settings.ConnectionString, out string connectionString, true);
currentSettings.ConnectionString = connectionString;
}
MySqlPool pool = MySqlPoolManager.GetPool(currentSettings);
if (driver == null || !driver.IsOpen)
{
driver = pool.GetConnection();
}
ProcedureCache = pool.ProcedureCache;
}
else
{
if (driver == null || !driver.IsOpen)
{
driver = Driver.Create(currentSettings);
}
ProcedureCache = new ProcedureCache((int)Settings.ProcedureCacheSize);
}
}
catch (Exception)
{
SetState(ConnectionState.Closed, true);
throw;
}
SetState(ConnectionState.Open, false);
driver.Configure(this);
if (driver.IsPasswordExpired && Settings.Pooling)
{
MySqlPoolManager.ClearPool(currentSettings);
}
if (!(driver.SupportsPasswordExpiration && driver.IsPasswordExpired))
{
if (!string.IsNullOrEmpty(Settings.Database))
{
ChangeDatabase(Settings.Database);
}
}
// setup our schema provider
_schemaProvider = new ISSchemaProvider(this);
PerfMonitor = new PerformanceMonitor(this);
// if we are opening up inside a current transaction, then autoenlist
// TODO: control this with a connection string option
if (Transaction.Current != null && Settings.AutoEnlist)
{
EnlistTransaction(Transaction.Current);
}
hasBeenOpen = true;
SetState(ConnectionState.Open, true);
}