MontoyaTech/MySqlPlus
MontoyaTech/MySqlPlus
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Bumped package version to 1.1.2. Improved documentation, simplified the column attribute and added the ability to mark columns as unique. Indexes now don't need a name to be specified, one will be generated if none is provided, and a few other wording changes and renaming was done.

Browse Source
This commit is contained in:
MattMo 2023-06-13 15:08:40 -07:00
parent f38a08b1cf
commit b323dc14eb
7 changed files with 70 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
MySqlPlus.Example/Program.cs
View File

@ -10,7 +10,7 @@ namespace MontoyaTech.MySqlPlus.Example
[MySqlRowIndex("year", "year")] [MySqlRowIndex("year", "year")]
public class Car public class Car
{ {
[MySqlColumn(Id = true, Name = "id", PrimaryKey = true, AutoIncrement = true)] [MySqlColumn(Name = "id", PrimaryKey = true, AutoIncrement = true)]
public ulong Id = 0; public ulong Id = 0;
[MySqlColumn("make")] [MySqlColumn("make")]

18
MySqlPlus/MySqlColumn.cs
View File

@ -17,27 +17,27 @@ namespace MontoyaTech.MySqlPlus
public class MySqlColumn : Attribute public class MySqlColumn : Attribute
{ {
/// <summary> /// <summary>
/// Whether or not this column is the row id. /// The name of the column, if null, the field name will be used instead. Default is null.
/// </summary>
public bool Id = false;
/// <summary>
/// The name of the column, if null, the field name will be used instead.
/// </summary> /// </summary>
public string Name = null; public string Name = null;
/// <summary> /// <summary>
/// The MySql Data type of the column, if null, the field type will be used instead. /// The MySql Data type of the column, if null, the field type will be used instead. Default is null.
/// </summary> /// </summary>
public string Type = null; public string Type = null;
/// <summary> /// <summary>
/// Whether or not this column is a primary key. /// Whether or not this column is a primary key. Default is false.
/// </summary> /// </summary>
public bool PrimaryKey = false; public bool PrimaryKey = false;
/// <summary> /// <summary>
/// Whether or not this column auto increments. /// Whether or not this column is unique. Default is false.
/// </summary>
public bool Unique = false;
/// <summary>
/// Whether or not this column auto increments. Default is false.
/// </summary> /// </summary>
public bool AutoIncrement = false; public bool AutoIncrement = false;

12
MySqlPlus/MySqlColumnExtensions.cs
View File

@ -22,11 +22,11 @@ namespace MontoyaTech.MySqlPlus
/// <param name="row"></param> /// <param name="row"></param>
/// <param name="field"></param> /// <param name="field"></param>
/// <param name="idColumn"></param> /// <param name="idColumn"></param>
public static bool GetMySqlId<T>(this T row, out FieldInfo field, out MySqlColumn idColumn) public static bool GetMySqlPrimaryKey<T>(this T row, out FieldInfo field, out MySqlColumn idColumn)
{ {
var type = typeof(T); var type = typeof(T);
return GetMySqlId(type, out field, out idColumn); return GetMySqlPrimaryKey(type, out field, out idColumn);
} }
/// <summary> /// <summary>
@ -37,7 +37,7 @@ namespace MontoyaTech.MySqlPlus
/// <param name="field"></param> /// <param name="field"></param>
/// <param name="idColumn"></param> /// <param name="idColumn"></param>
/// <returns></returns> /// <returns></returns>
public static bool GetMySqlId(this Type type, out FieldInfo field, out MySqlColumn idColumn) public static bool GetMySqlPrimaryKey(this Type type, out FieldInfo field, out MySqlColumn idColumn)
{ {
field = null; field = null;
@ -52,7 +52,7 @@ namespace MontoyaTech.MySqlPlus
{ {
var column = fields[i].GetCustomAttribute<MySqlColumn>(); var column = fields[i].GetCustomAttribute<MySqlColumn>();
if (column != null && column.Id) if (column != null && column.PrimaryKey)
{ {
field = fields[i]; field = fields[i];
idColumn = column; idColumn = column;
@ -246,6 +246,10 @@ namespace MontoyaTech.MySqlPlus
/// <returns></returns> /// <returns></returns>
public static bool IsNullable<T>(this MySqlColumn column, FieldInfo field, T row) public static bool IsNullable<T>(this MySqlColumn column, FieldInfo field, T row)
{ {
//If the column is the primary key, it cannot be null.
if (column.PrimaryKey)
return false;
var fieldType = field.FieldType; var fieldType = field.FieldType;
var defaultValue = field.GetValue(row); var defaultValue = field.GetValue(row);

70
MySqlPlus/MySqlCommandExtensions.cs
View File

@ -51,8 +51,8 @@ namespace MontoyaTech.MySqlPlus
if (column == null) if (column == null)
continue; continue;
//Skip id columns because they are auto incremented. //Skip any columns that are auto incremented.
if (column.Id) if (column.AutoIncrement)
continue; continue;
if (seperate) if (seperate)
@ -99,8 +99,8 @@ namespace MontoyaTech.MySqlPlus
//Write the set values section //Write the set values section
builder.Append("SET "); builder.Append("SET ");
FieldInfo idField = null; FieldInfo primaryField = null;
MySqlColumn idColumn = null; MySqlColumn primaryColumn = null;
bool seperate = false; bool seperate = false;
for (int i = 0; i < fields.Length; i++) for (int i = 0; i < fields.Length; i++)
{ {
@ -109,14 +109,17 @@ namespace MontoyaTech.MySqlPlus
if (column == null) if (column == null)
continue; continue;
//Skip id columns because they are auto incremented. //If this column is the primary key, grab it.
if (column.Id) if (column.PrimaryKey)
{ {
idField = fields[i]; primaryField = fields[i];
idColumn = column; primaryColumn = column;
continue;
} }
//Skip any columns that are auto incremented.
if (column.AutoIncrement)
continue;
if (seperate) if (seperate)
builder.Append(", "); builder.Append(", ");
@ -127,14 +130,14 @@ namespace MontoyaTech.MySqlPlus
seperate = true; seperate = true;
} }
//Make sure we have an id column. //Make sure we have a primary key.
if (idField == null) if (primaryField == null)
throw new Exception("Given row does not contain an id column"); throw new Exception("Given row does not contain primary key.");
//Write the where clause //Write the where clause
builder.Append($" WHERE `{(string.IsNullOrWhiteSpace(idColumn.Name) ? idField.Name : idColumn.Name)}`=@id LIMIT 1"); builder.Append($" WHERE `{(string.IsNullOrWhiteSpace(primaryColumn.Name) ? primaryField.Name : primaryColumn.Name)}`=@id LIMIT 1");
command.Parameters.AddWithValue("@id", idField.GetValue(row)); command.Parameters.AddWithValue("@id", primaryField.GetValue(row));
//Set the command text. //Set the command text.
command.CommandText = builder.ToString(); command.CommandText = builder.ToString();
@ -156,11 +159,11 @@ namespace MontoyaTech.MySqlPlus
var rowAttribute = rowType.GetCustomAttribute<MySqlRow>(); var rowAttribute = rowType.GetCustomAttribute<MySqlRow>();
//Get the id field //Get the id field
if (!rowType.GetMySqlId(out FieldInfo idField, out MySqlColumn idColumn)) if (!rowType.GetMySqlPrimaryKey(out FieldInfo primaryField, out MySqlColumn primaryColumn))
throw new Exception("Failed to find the id column on the given row."); throw new Exception("Failed to find the primary key for the given row.");
//Set the command text. //Set the command text.
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"; command.CommandText = $"SELECT * FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.Name : rowAttribute.Name)}` WHERE `{(string.IsNullOrWhiteSpace(primaryColumn.Name) ? primaryField.Name : primaryColumn.Name)}`=@id LIMIT 1";
//Add the id parameter. //Add the id parameter.
command.Parameters.AddWithValue("@id", id); command.Parameters.AddWithValue("@id", id);
@ -204,15 +207,15 @@ namespace MontoyaTech.MySqlPlus
//Write the delete from section //Write the delete from section
builder.Append($"DELETE FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.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 //Get the primary field and column
if (!row.GetMySqlId(out FieldInfo idField, out MySqlColumn idColumn)) if (!row.GetMySqlPrimaryKey(out FieldInfo primaryField, out MySqlColumn primaryColumn))
throw new Exception("Failed to find Id column on row."); throw new Exception("Failed to find primary key for given row.");
//Write the where clause //Write the where clause
builder.Append($"WHERE `{(string.IsNullOrWhiteSpace(idColumn.Name) ? idField.Name : idColumn.Name)}`=@id LIMIT 1"); builder.Append($"WHERE `{(string.IsNullOrWhiteSpace(primaryColumn.Name) ? primaryField.Name : primaryColumn.Name)}`=@id LIMIT 1");
//Add the id parameter. //Add the id parameter.
command.Parameters.AddWithValue("@id", idField.GetValue(row)); command.Parameters.AddWithValue("@id", primaryField.GetValue(row));
//Set the command text. //Set the command text.
command.CommandText = builder.ToString(); command.CommandText = builder.ToString();
@ -238,12 +241,12 @@ namespace MontoyaTech.MySqlPlus
//Write the delete from section //Write the delete from section
builder.Append($"DELETE FROM `{(rowAttribute == null || string.IsNullOrWhiteSpace(rowAttribute.Name) ? rowType.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 //Get the primary key field and column.
if (!rowType.GetMySqlId(out FieldInfo idField, out MySqlColumn idColumn)) if (!rowType.GetMySqlPrimaryKey(out FieldInfo primaryField, out MySqlColumn primaryColumn))
throw new Exception("Failed to find Id column on row."); throw new Exception("Failed to find primary key for the given row.");
//Write the where clause //Write the where clause
builder.Append($"WHERE `{(string.IsNullOrWhiteSpace(idColumn.Name) ? idField.Name : idColumn.Name)}`=@id LIMIT 1"); builder.Append($"WHERE `{(string.IsNullOrWhiteSpace(primaryColumn.Name) ? primaryField.Name : primaryColumn.Name)}`=@id LIMIT 1");
//Add the id parameter. //Add the id parameter.
command.Parameters.AddWithValue("@id", id); command.Parameters.AddWithValue("@id", id);
@ -315,8 +318,10 @@ namespace MontoyaTech.MySqlPlus
if (separate) if (separate)
builder.Append(", "); builder.Append(", ");
var columnName = string.IsNullOrWhiteSpace(column.Name) ? fields[i].Name : column.Name;
//Write the column name //Write the column name
builder.Append($"{(string.IsNullOrWhiteSpace(column.Name) ? fields[i].Name : column.Name)} "); builder.Append($"{columnName} ");
//Write the column data type //Write the column data type
builder.Append($"{column.GetMySqlColumnType(fields[i])} "); builder.Append($"{column.GetMySqlColumnType(fields[i])} ");
@ -352,8 +357,12 @@ namespace MontoyaTech.MySqlPlus
//Write the column auto increment information. //Write the column auto increment information.
builder.Append($"{(column.AutoIncrement ? "AUTO_INCREMENT" : "")}"); builder.Append($"{(column.AutoIncrement ? "AUTO_INCREMENT" : "")}");
//If the column is the primary key, output that constraint.
if (column.PrimaryKey) if (column.PrimaryKey)
builder.Append($", PRIMARY KEY ({(string.IsNullOrWhiteSpace(column.Name) ? fields[i].Name : column.Name)})"); builder.Append($", PRIMARY KEY ({columnName})");
//If the column is unique, output that constraint, but you can't be the primary key and be unique.
else if (column.Unique)
builder.Append($", UNIQUE ({columnName})");
separate = true; separate = true;
} }
@ -374,7 +383,10 @@ namespace MontoyaTech.MySqlPlus
if (separate) if (separate)
builder.Append(", "); builder.Append(", ");
builder.Append($"INDEX {index.Name} ({index.Columns.Aggregate((curr, next) => curr == null ? next : curr + ", " + next)})"); if (string.IsNullOrWhiteSpace(index.Name))
builder.Append($"INDEX IDX_{index.Columns.Aggregate((curr, next) => curr == null ? next : curr + "_" + next)} ({index.Columns.Aggregate((curr, next) => curr == null ? next : curr + ", " + next)})");
else
builder.Append($"INDEX {index.Name} ({index.Columns.Aggregate((curr, next) => curr == null ? next : curr + ", " + next)})");
separate = true; separate = true;
} }

2
MySqlPlus/MySqlPlus.csproj
View File

@ -7,7 +7,7 @@
<AssemblyName>MontoyaTech.MySqlPlus</AssemblyName> <AssemblyName>MontoyaTech.MySqlPlus</AssemblyName>
<RootNamespace>MontoyaTech.MySqlPlus</RootNamespace> <RootNamespace>MontoyaTech.MySqlPlus</RootNamespace>
<Title>MontoyaTech.MySqlPlus</Title> <Title>MontoyaTech.MySqlPlus</Title>
<Version>1.1.1</Version> <Version>1.1.2</Version>
<Company>MontoyaTech</Company> <Company>MontoyaTech</Company>
<Description>A simple C# library to help work with MySql.</Description> <Description>A simple C# library to help work with MySql.</Description>
<Copyright>MontoyaTech 2023</Copyright> <Copyright>MontoyaTech 2023</Copyright>

13
MySqlPlus/MySqlRowIndex.cs
View File

@ -14,14 +14,14 @@ namespace MontoyaTech.MySqlPlus
public class MySqlRowIndex : Attribute public class MySqlRowIndex : Attribute
{ {
/// <summary> /// <summary>
/// The name of this index. /// The name of this index. Default is null. If null, one will be created automatically.
/// </summary> /// </summary>
public string Name; public string Name = null;
/// <summary> /// <summary>
/// The name of the columns that belong to this index. /// The name of the columns that belong to this index.
/// </summary> /// </summary>
public string[] Columns; public string[] Columns = null;
/// <summary> /// <summary>
/// Creates a new default MySqlRowIndex. /// Creates a new default MySqlRowIndex.
@ -29,18 +29,15 @@ namespace MontoyaTech.MySqlPlus
public MySqlRowIndex() { } public MySqlRowIndex() { }
/// <summary> /// <summary>
/// Creates a new default MySqlRowIndex with a name and column names. /// Creates a new default MySqlRowIndex with column names apart of the index.
/// </summary> /// </summary>
/// <param name="name"></param>
/// <param name="columns"></param> /// <param name="columns"></param>
/// <exception cref="ArgumentException"></exception> /// <exception cref="ArgumentException"></exception>
public MySqlRowIndex(string name, params string[] columns) public MySqlRowIndex(params string[] columns)
{ {
if (columns == null || columns.Length == 0) if (columns == null || columns.Length == 0)
throw new ArgumentException("Columns must not be null or 0."); throw new ArgumentException("Columns must not be null or 0.");
this.Name = name;
this.Columns = columns; this.Columns = columns;
} }
} }

9
MySqlPlus/MySqlSession.cs
View File

@ -69,12 +69,13 @@ namespace MontoyaTech.MySqlPlus
this.Connection.ExecuteNonQuery(command); this.Connection.ExecuteNonQuery(command);
if (row.GetMySqlId(out FieldInfo idField, out MySqlColumn idColumn)) //Update the primary key value on the row if we can find it.
if (row.GetMySqlPrimaryKey(out FieldInfo primaryField, out MySqlColumn primaryColumn))
{ {
if (Type.GetTypeCode(idField.FieldType) == TypeCode.UInt64) if (Type.GetTypeCode(primaryField.FieldType) == TypeCode.UInt64)
idField.SetValue(row, (ulong)command.LastInsertedId); primaryField.SetValue(row, (ulong)command.LastInsertedId);
else else
idField.SetValue(row, command.LastInsertedId); primaryField.SetValue(row, command.LastInsertedId);
} }
return (ulong)command.LastInsertedId; return (ulong)command.LastInsertedId;