UskokMySQL 1.4.0

Uskok-MYSQL

Uskok-MYSQL is a library that I used to do some private work so I thought why not upload it to github. It uses .NET Reflections to achieve a bit painless mysql experience in .NET. Also it creates async mysql connection pool so that creating a new connection for each request it not required. Amount of open connection at one time is customizable for each database.

Examples

Connecting to a database

//This line connects to a database in another thread and opens 5 concurrent connections
Database Database = new("ConnectionString", 5);

Creating a table

Database Database = new("ConnectionString", 5);
class TestTableColumn
{
    public int ID;
    public string Name;
}
//This creates a table and executes a mysql query to create the table if it does not exist.
//The create request 'CREATE TABLE IF NOT EXISTS `Table_Name`(ID INT, Name TEXT);'

DatabaseTable<TestTableColumn> Table = new("Table_Name", Database);
//Note: the operation is concurrent so the table might not be created in the database 
//even after this line so use Table.Created variable if you want to check 

Column Attributes

PrimaryKey

Used for marking the primary key of the table(please use only one per table):

class Person
{
    [PrimaryKey]
    public int SocialNumber;
    public string Name;
}

Results in:

CREATE TABLE IF NOT EXIST `Table_Name` (SocialNumber INT PRIMARY KEY, Name TEXT);'

AutoIncrement

Used for marking a auto increment column When inserting this column will autmaticlly be assigned to null

class Person
{
    [AutoIncrement]
    public int SocialNumber;
    public string Name;
}

Results in:

CREATE TABLE IF NOT EXIST `Table_Name` (SocialNumber INT AUTO_INCREMENT, Name TEXT);

NotNull

Used for marking a column that is not null

class Person
{
    public int SocialNumber;
    [NotNull]
    public string Name;
}

Results in:

CREATE TABLE IF NOT EXIST `Table_Name` (SocialNumber INT, Name TEXT NOT NULL);

ColumnIgnore

Used for marking a column that is to be ignored

class Person
{
    public int SocialNumber;
    [ColumnIgnore]
    public string Name;
}

Results in:

CREATE TABLE IF NOT EXIST `Table_Name` (SocialNumber INT);

MaxLength

Used for specifying the max length in a string(converts it to varchar)

class Person
{
    public int SocialNumber;
    [MaxLength(30)]
    public string Name;
}

Results in:

CREATE TABLE IF NOT EXIST `Table_Name` (SocialNumber INT, Name VARCHAR(30));

ColumnName

Used for setting a custom name to a column

class Person
{
    public int SocialNumber;
    [ColumnName("personName")]
    public string Name;
}

Results in:

CREATE TABLE IF NOT EXIST `Table_Name` (SocialNumber INT, personName TEXT);

Writing queries

Inserting & Replacing

class Person
{
    [PrimaryKey]
    public int SocialNumber;
    public string Name;
}
DatabaseTable<Person> Table = new("Table_Name", Database);
Person p1 = new () { SocialNumber = 0, Name = "John Doe" };
Person p2 = new () { SocialNumber = 1, Name = "John Doe" };
...
await Table.Insert(p1, p2, ...);

Now renaming(replacing) them

p1.Name = "New John";
p2.Name = "New Jane";
...
await Table.Replace(p1, p2, ...);

Inserting and getting inserted ids

class Person
{
    [PrimaryKey, AutoIncrement]
    public long SocialNumber;
    public string Name;
}
DatabaseTable<Person> Table = new("Table_Name", Database);
Person p1 = new (){ Name = "John Doe" };
Person p2 = new (){ Name = "Jane Doe" };
long[] ids = await Table.InsertAndReturnKeys<long>(p1, p2);
// Table content
// SocialNumber  |  Name
//      0        |  "John Doe"
//      1        |  "John Doe"
// ids Array
// Index | Value
//   0   |   0
//   1   |   1

Where query

Use Table.All for all where queries, example:

All(string? whereCommand = null, string? alias = null, string? selector = null, bool debugPrint = false)<br> An example of SELECT * FROM table_name WHERE name='John'

class Person
{
    [PrimaryKey, AutoIncrement]
    public long SocialNumber;
    public string Name;
}
DatabaseTable<Person> Table = new("Table_Name", Database);
List<Person> peopleOfNameJohn = await Table.All("name='John'");

Now explaining the parameters

selector(default: *) - SELECT selector FROM<br> alias - if used it adds a string after the FROM: SELECT selector FROM Table_Name as alias<br> whereCommand - used