From c4c39bfc46aa6a7e0122e74cfec68f454336e151 Mon Sep 17 00:00:00 2001 From: MattMo Date: Tue, 31 Jan 2023 16:58:19 -0800 Subject: [PATCH] Improved MySqlManagedConnection retry logic. Added new MySqlRowIndex attribute to specify the indexes for a given row. Improved documentation and the example program. Bumped version number to 1.0.5 --- MySqlPlus.Example/Program.cs | 2 + MySqlPlus/MySqlCommandExtensions.cs | 101 +++++++++++------- MySqlPlus/MySqlDataReaderExtensions.cs | 16 +-- MySqlPlus/MySqlManagedConnection.cs | 142 +++++++++++++++++++++---- MySqlPlus/MySqlPlus.csproj | 2 +- MySqlPlus/MySqlRowIndex.cs | 32 ++++++ 6 files changed, 224 insertions(+), 71 deletions(-) create mode 100644 MySqlPlus/MySqlRowIndex.cs diff --git a/MySqlPlus.Example/Program.cs b/MySqlPlus.Example/Program.cs index bb42f9c..2dc5d19 100644 --- a/MySqlPlus.Example/Program.cs +++ b/MySqlPlus.Example/Program.cs @@ -6,6 +6,8 @@ namespace MontoyaTech.MySqlPlus.Example public class Program { [MySqlRow("cars")] + [MySqlRowIndex("make_model", "model", "year")] + [MySqlRowIndex("year", "year")] public class Car { [MySqlColumn(Id = true, Name = "id", PrimaryKey = true, AutoIncrement = true, Nullable = false)] diff --git a/MySqlPlus/MySqlCommandExtensions.cs b/MySqlPlus/MySqlCommandExtensions.cs index 78e4f4b..2a78766 100644 --- a/MySqlPlus/MySqlCommandExtensions.cs +++ b/MySqlPlus/MySqlCommandExtensions.cs @@ -23,13 +23,13 @@ namespace MontoyaTech.MySqlPlus public static void Insert(this MySqlCommand command, T row) { //Get the type of T - var type = typeof(T); + var rowType = typeof(T); //Get the row information. - var rowAttribute = type.GetCustomAttribute(); + var rowAttribute = rowType.GetCustomAttribute(); //Get all the fields. - var fields = type.GetFields(); + var fields = rowType.GetFields(); if (fields == null || fields.Length == 0) throw new Exception("Found no public fields on given row."); @@ -38,7 +38,7 @@ namespace MontoyaTech.MySqlPlus var builder = new StringBuilder(); //Write the insert section. - builder.Append($"INSERT INTO `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? type.Name : rowAttribute.Name)}` "); + builder.Append($"INSERT INTO `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}` "); //Write the set values section. builder.Append("SET "); @@ -79,13 +79,13 @@ namespace MontoyaTech.MySqlPlus public static void Update(this MySqlCommand command, T row) { //Get the type of T - var type = typeof(T); + var rowType = typeof(T); //Get the row information. - var rowAttribute = type.GetCustomAttribute(); + var rowAttribute = rowType.GetCustomAttribute(); //Get all the fields. - var fields = type.GetFields(); + var fields = rowType.GetFields(); if (fields == null || fields.Length == 0) throw new Exception("Found no public fields on given row."); @@ -94,7 +94,7 @@ namespace MontoyaTech.MySqlPlus var builder = new StringBuilder(); //Write the update section - builder.Append($"UPDATE `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? type.Name : rowAttribute.Name)}` "); + builder.Append($"UPDATE `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}` "); //Write the set values section builder.Append("SET "); @@ -150,17 +150,17 @@ namespace MontoyaTech.MySqlPlus public static void Get(this MySqlCommand command, ulong id) { //Get the type of T - var type = typeof(T); + var rowType = typeof(T); //Get the row information. - var rowAttribute = type.GetCustomAttribute(); + var rowAttribute = rowType.GetCustomAttribute(); //Get the id field - if (!type.GetMySqlId(out FieldInfo idField, out MySqlColumn idColumn)) + if (!rowType.GetMySqlId(out FieldInfo idField, out MySqlColumn idColumn)) throw new Exception("Failed to find the id column on the given row."); //Set the command text. - command.CommandText = $"SELECT * FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? type.Name : rowAttribute.Name)}` WHERE `{(string.IsNullOrWhiteSpace(idColumn.Name) ? idField.Name : idColumn.Name)}`=@id LIMIT 1"; + command.CommandText = $"SELECT * FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}` WHERE `{(string.IsNullOrWhiteSpace(idColumn.Name) ? idField.Name : idColumn.Name)}`=@id LIMIT 1"; //Add the id parameter. command.Parameters.AddWithValue("@id", id); @@ -174,13 +174,13 @@ namespace MontoyaTech.MySqlPlus public static void GetAll(this MySqlCommand command) { //Get the type of T - var type = typeof(T); + var rowType = typeof(T); //Get the row information. - var rowAttribute = type.GetCustomAttribute(); + var rowAttribute = rowType.GetCustomAttribute(); //Set the command text. - command.CommandText = $"SELECT * FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? type.Name : rowAttribute.Name)}`"; + command.CommandText = $"SELECT * FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}`"; } /// @@ -193,16 +193,16 @@ namespace MontoyaTech.MySqlPlus public static void Delete(this MySqlCommand command, T row) { //Get the type of T - var type = typeof(T); + var rowType = typeof(T); //Get the row information. - var rowAttribute = type.GetCustomAttribute(); + var rowAttribute = rowType.GetCustomAttribute(); //Start building the query. var builder = new StringBuilder(); //Write the delete from section - builder.Append($"DELETE FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? type.Name : rowAttribute.Name)}` "); + builder.Append($"DELETE FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}` "); //Get the id the column and field info if (!row.GetMySqlId(out FieldInfo idField, out MySqlColumn idColumn)) @@ -227,19 +227,19 @@ namespace MontoyaTech.MySqlPlus public static void Delete(this MySqlCommand command, ulong id) { //Get the type of T - var type = typeof(T); + var rowType = typeof(T); //Get the row information. - var rowAttribute = type.GetCustomAttribute(); + var rowAttribute = rowType.GetCustomAttribute(); //Start building the query. var builder = new StringBuilder(); //Write the delete from section - builder.Append($"DELETE FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? type.Name : rowAttribute.Name)}` "); + builder.Append($"DELETE FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}` "); //Get the id the column and field info - if (!type.GetMySqlId(out FieldInfo idField, out MySqlColumn idColumn)) + if (!rowType.GetMySqlId(out FieldInfo idField, out MySqlColumn idColumn)) throw new Exception("Failed to find Id column on row."); //Write the where clause @@ -260,16 +260,16 @@ namespace MontoyaTech.MySqlPlus public static void DeleteAll(this MySqlCommand command) { //Get the type of T - var type = typeof(T); + var rowType = typeof(T); //Get the row information. - var rowAttribute = type.GetCustomAttribute(); + var rowAttribute = rowType.GetCustomAttribute(); //Start building the query. var builder = new StringBuilder(); //Write the delete from section - builder.Append($"DELETE FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? type.Name : rowAttribute.Name)}`"); + builder.Append($"DELETE FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}`"); //Set the command text. command.CommandText = builder.ToString(); @@ -283,26 +283,27 @@ namespace MontoyaTech.MySqlPlus public static void CreateTable(this MySqlCommand command) { //Get the type of T - var type = typeof(T); + var rowType = typeof(T); //Create a new instance of the row - var row = type.CreateInstance(); + var row = rowType.CreateInstance(); //Get the row information. - var rowAttribute = type.GetCustomAttribute(); + var rowAttribute = rowType.GetCustomAttribute(); //Start building the query. var builder = new StringBuilder(); //Write the delete from section - builder.Append($"CREATE TABLE `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? type.Name : rowAttribute.Name)}` ("); + builder.Append($"CREATE TABLE `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}` ("); //Write all the columns - var fields = type.GetFields(); + var fields = rowType.GetFields(); + + bool separate = false; if (fields != null) { - bool separate = false; for (int i = 0; i < fields.Length; i++) { var field = fields[i]; @@ -355,6 +356,26 @@ namespace MontoyaTech.MySqlPlus } } + //Add any indexes + var indexes = rowType.GetCustomAttributes().ToList(); + if (indexes != null) + { + for (int i = 0; i < indexes.Count; i++) + { + var index = indexes[i]; + + if (index.Columns == null || index.Columns.Length == 0) + continue; + + if (separate) + builder.Append(", "); + + builder.Append($"INDEX {index.Name} ({index.Columns.Aggregate((curr, next) => curr == null ? next : curr + ", " + next)})"); + + separate = true; + } + } + builder.Append(")"); //Set the command text. @@ -369,16 +390,16 @@ namespace MontoyaTech.MySqlPlus public static void TableExists(this MySqlCommand command) { //Get the type of T - var type = typeof(T); + var rowType = typeof(T); //Get the row information. - var rowAttribute = type.GetCustomAttribute(); + var rowAttribute = rowType.GetCustomAttribute(); //Start building the query. var builder = new StringBuilder(); //Write the delete from section - builder.Append($"SHOW TABLES LIKE '{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? type.Name : rowAttribute.Name)}'"); + builder.Append($"SHOW TABLES LIKE '{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}'"); //Set the command text command.CommandText = builder.ToString(); @@ -392,16 +413,16 @@ namespace MontoyaTech.MySqlPlus public static void EmptyTable(this MySqlCommand command) { //Get the type of T - var type = typeof(T); + var rowType = typeof(T); //Get the row information. - var rowAttribute = type.GetCustomAttribute(); + var rowAttribute = rowType.GetCustomAttribute(); //Start building the query. var builder = new StringBuilder(); //Write the delete from section - builder.Append($"TRUNCATE TABLE `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? type.Name : rowAttribute.Name)}`"); + builder.Append($"TRUNCATE TABLE `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}`"); //Set the command text command.CommandText = builder.ToString(); @@ -415,16 +436,16 @@ namespace MontoyaTech.MySqlPlus public static void DeleteTable(this MySqlCommand command) { //Get the type of T - var type = typeof(T); + var rowType = typeof(T); //Get the row information. - var rowAttribute = type.GetCustomAttribute(); + var rowAttribute = rowType.GetCustomAttribute(); //Start building the query. var builder = new StringBuilder(); //Write the delete from section - builder.Append($"DROP TABLE `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? type.Name : rowAttribute.Name)}`"); + builder.Append($"DROP TABLE `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}`"); //Set the command text command.CommandText = builder.ToString(); diff --git a/MySqlPlus/MySqlDataReaderExtensions.cs b/MySqlPlus/MySqlDataReaderExtensions.cs index 1db3130..3392f50 100644 --- a/MySqlPlus/MySqlDataReaderExtensions.cs +++ b/MySqlPlus/MySqlDataReaderExtensions.cs @@ -45,9 +45,9 @@ namespace MontoyaTech.MySqlPlus if (!reader.Read()) return false; - var type = typeof(T); + var rowType = typeof(T); - var fields = type.GetFields(); + var fields = rowType.GetFields(); if (fields == null || fields.Length == 0) throw new Exception("Found no public fields on given row."); @@ -79,14 +79,14 @@ namespace MontoyaTech.MySqlPlus if (!reader.Read()) return false; - var type = typeof(T); + var rowType = typeof(T); - var fields = type.GetFields(); + var fields = rowType.GetFields(); if (fields == null || fields.Length == 0) throw new Exception("Found no public fields on given row."); - row = type.CreateInstance(); + row = rowType.CreateInstance(); for (int i = 0; i < fields.Length; i++) { @@ -124,16 +124,16 @@ namespace MontoyaTech.MySqlPlus /// public static void ReadAll(this MySqlDataReader reader, List rows) { - var type = typeof(T); + var rowType = typeof(T); - var fields = type.GetFields(); + var fields = rowType.GetFields(); if (fields == null || fields.Length == 0) throw new Exception("Found no public fields on given row."); while (reader.Read()) { - var row = type.CreateInstance(); + var row = rowType.CreateInstance(); for (int i = 0; i < fields.Length; i++) { diff --git a/MySqlPlus/MySqlManagedConnection.cs b/MySqlPlus/MySqlManagedConnection.cs index 0b67952..bc07b40 100644 --- a/MySqlPlus/MySqlManagedConnection.cs +++ b/MySqlPlus/MySqlManagedConnection.cs @@ -73,9 +73,10 @@ namespace MontoyaTech.MySqlPlus } /// - /// Attempts to reconnect to the server and retrys if needed. + /// Attempts to reconnect to the server and retrys if needed, returns whether or not a connection + /// was successfully reastablished. /// - public void Reconnect(int maxRetrys = 5, bool exponentialBackoff = true, bool retry = true) + public bool Reconnect(int maxRetrys = 5, bool exponentialBackoff = true, bool retry = true) { int backoffSleep = 2000; for (int i = 0; i < maxRetrys; i++) @@ -99,7 +100,7 @@ namespace MontoyaTech.MySqlPlus //If we are now connected then stop trying. if (this.IsConnected) - break; + return true; else throw new Exception("Failed to open a valid MySqlConnection."); } @@ -117,6 +118,8 @@ namespace MontoyaTech.MySqlPlus } } } + + return false; } /// @@ -263,18 +266,23 @@ namespace MontoyaTech.MySqlPlus ex.Message.ToLower().Contains("a connection attempt failed because the connected party did not properly respond after a period of time") || ex.Message.ToLower().Contains("an existing connection was forcibly closed by the remote host")) { - this.Reconnect(maxRetrys, exponentialBackoff); + //Attempt to reconnect, but if this fails, it means we can't try any more since the reconnect retrys more than once. + if (!this.Reconnect(maxRetrys, exponentialBackoff)) + throw; } - //See if we should retry or just throw. - if (!ShouldRetryBasedOnMySqlErrorNum(code)) - throw; - - //If the operation took less than 5 seconds, then sleep. Otherwise continue right away. - if (GlobalTimeStamp.GetDifference(startTimestamp) <= 5000 && exponentialBackoff) + else if (!ShouldRetryBasedOnMySqlErrorNum(code)) { - Thread.Sleep(backoffSleep); - backoffSleep *= 2; + throw; + } + else + { + //If the operation took less than 5 seconds, then sleep. Otherwise continue right away. + if (GlobalTimeStamp.GetDifference(startTimestamp) <= 5000 && exponentialBackoff) + { + Thread.Sleep(backoffSleep); + backoffSleep *= 2; + } } } } @@ -290,16 +298,106 @@ namespace MontoyaTech.MySqlPlus private static bool ShouldRetryBasedOnMySqlErrorNum(int number) { //List of codes here: https://www.briandunning.com/error-codes/?source=MySQL - if (number >= 1044 && number <= 1052) - return false; - else if (number >= 1054 && number <= 1075) - return false; - else if (number == 1265) - return false; //Data truncation (Don't try again) - else if (number == 1264) - return false; //Value out of range (Don't try again) - - return true; + switch (number) + { + case 1021: + case 1023: + case 1027: + case 1030: + case 1037: + case 1038: + case 1040: + case 1041: + case 1043: + case 1076: + case 1078: + case 1079: + case 1080: + case 1081: + case 1094: + case 1099: + case 1105: + case 1119: + case 1129: + case 1130: + case 1135: + case 1150: + case 1151: + case 1152: + case 1154: + case 1155: + case 1157: + case 1158: + case 1160: + case 1161: + case 1180: + case 1181: + case 1182: + case 1183: + case 1184: + case 1186: + case 1189: + case 1190: + case 1192: + case 1194: + case 1195: + case 1196: + case 1199: + case 1200: + case 1202: + case 1203: + case 1205: + case 1206: + case 1207: + case 1208: + case 1213: + case 1218: + case 1219: + case 1220: + case 1236: + case 1244: + case 1257: + case 1258: + case 1259: + case 1297: + case 1316: + case 1341: + case 2000: + case 2001: + case 2002: + case 2003: + case 2004: + case 2005: + case 2006: + case 2007: + case 2008: + case 2009: + case 2010: + case 2011: + case 2012: + case 2013: + case 2014: + case 2024: + case 2025: + case 2026: + case 2027: + case 2037: + case 2038: + case 2039: + case 2040: + case 2041: + case 2042: + case 2043: + case 2044: + case 2045: + case 2046: + case 2048: + case 2050: + case 2051: + return true; + default: + return false; + } } /// diff --git a/MySqlPlus/MySqlPlus.csproj b/MySqlPlus/MySqlPlus.csproj index 1334d62..e794753 100644 --- a/MySqlPlus/MySqlPlus.csproj +++ b/MySqlPlus/MySqlPlus.csproj @@ -7,7 +7,7 @@ MontoyaTech.MySqlPlus MontoyaTech.MySqlPlus MontoyaTech.MySqlPlus - 1.0.4 + 1.0.5 MontoyaTech A simple C# library to help work with MySql. MontoyaTech 2023 diff --git a/MySqlPlus/MySqlRowIndex.cs b/MySqlPlus/MySqlRowIndex.cs new file mode 100644 index 0000000..5ffe50a --- /dev/null +++ b/MySqlPlus/MySqlRowIndex.cs @@ -0,0 +1,32 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace MontoyaTech.MySqlPlus +{ + /// + /// The outline of a MySqlRowIndex attribute which allows the specification + /// of an index for a row. + /// + [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = true, Inherited = true)] + public class MySqlRowIndex : Attribute + { + public string Name; + + public string[] Columns; + + public MySqlRowIndex() { } + + public MySqlRowIndex(string name, params string[] columns) + { + if (columns == null || columns.Length == 0) + throw new ArgumentException("Columns must not be null or 0."); + + this.Name = name; + + this.Columns = columns; + } + } +}