MySqlDbController 1.7.8

Main features

This library allows you to conveniently and abstractly work with MySQL databases and tables. Using attributes, it determines which class properties to use when executing queries, how to fill them out, and how to read them. The library also provides the ability to create a table in the database based on a class filled with special attributes, and the ability to create a class file based on a table in the database. After creation, such a file contains a class with the necessary attributes for further work with this library, properties of the desired type, a default constructor, and, optionally, a manual constructor.

Working with a finished table

For the full work of your model with a table in the database, you need to use the Table and Column attributes. Table - an attribute that declares the name of the table in the database. Column - an attribute declaring the name of the column, as well as the presence and method of conversion enumeration, if the associated property is one. There are three simple rules for building a model that will work with our library:

1. all entity classes should be inherited from the DbObject class, which contains the Id property required by each table in MySQL;
2. both the class and properties must be public (properties must have a public setter);
3. all entity classes must have a public constructor without parameters.

This is how it looks in code:

namespace Test
{
    [Table("vat.man")]
    class Man : DbObject<int>
    {
        [Column("lastname")]
        public string Lastname { get; set; }

        [Column("age")]
        public int Age { get; set; }

        [Column("test_enum", true, typeof(Position), EnumConvertionMode.INT)]
        public Position TestEnum { get; set; }

        public Man() { }
    }

After this formal part, you can create an instance of the controller:

var controller = new DbController<Man, int>("localhost", "admin", "qwerty");

In the type parameters, you need to specify the entity and type of the identifier (int or long for example). Of the required: host address, username, and password. The controller constructor has many parameters, but most of them have a default value. I think users who have been working with MySQL for a long time will understand everything from the comments in the code. Now we have many interesting methods available: List<Entity> Select(), Entity SelectById(IdType id), void Insert(Entity cortege), void Update(Entity cortege), int Delete(IdType id).

"CodeFirst" and "DBFirst"

To save your time, we wrote an algorithm that creates a MySQL table based on a written class and generates a class file based on an existing table. For the library to be able to create the table, you must use the ColumnSettings attribute for the properties. The parameters of this attribute indicate the data type, dimension, default value, and more. Take a look at the code below:

namespace Test
{
    [Table("Man")]
    class Man : DbObject<int>
    {
        [Column("lastname")]
        [ColumnSettings(ColumnDataType.VARCHAR, 255, "Smith", true)]
        public string Lastname { get; set; }

        [Column("age")]
        [ColumnSettings(ColumnDataType.INT, 11, 30, true)]
        public int Age { get; set; }

        [Column("test_enum", true, typeof(Position), EnumConvertionMode.INT)]
        [ColumnSettings(ColumnDataType.INT)]
        public Position TestEnum { get; set; }

        public Man() { }
    }
}

Now, you need to create an instance of the controller and call the CreateTableIfNotExists method.

To create a class file, use the CreateClassFile method, which is located in the root class and does not require type parameters:

void CreateClassFile(destinationPath, tableName, nameSpace, true);

Unfortunately, for now, the class is not automatically added to the project. We are working on a VSIX extension with this functionality.