heleuto / easyorm Goto Github PK

This project forked from salim97/easyorm

0.0 0.0 0.0 33 KB

easy way to use ORM with Qt C++ and QML

License: GNU General Public License v3.0

C++ 78.76% C 6.71% QML 3.58% QMake 10.95%

easyorm's Introduction

easyORM

easyORM is easy library to create an equivalent of C++ class in SQL table ( sqlite3, mysql, ... ) and it allow you to use ORM design pattern, It is completely compatible for use with QML and C++

Current Status

Relation between SQL table and C++ Class
- Create
- Read
- Write
- Search
Custom
- emit signal before inserting data to sql table
- emit signal after reading data from sql table
- return JSON Object when selecting row from table

TODO

QML & C++
- add CRTP to easyORM.h
- add NOT NULL to cloumn
- add auto fill to tableview of qml
- Relation between two table
- return JSON object after executing custom query

SETUP

first copy easyORM folder to your project direcotry
then go to your .pro file and add this two lines


INCLUDEPATH += $$PWD/easyORM

include(easyORM/easyORM.pri)

How to use it

1- first we need to create an equivalent of table in C++

create simple C++ class and inhirent from easyORM class
add INIT_CURD and pass same name of your class
for each column in table you need to create a property, for example


#include "easyORM.h"

class Clients :  public easyORM
{

public:
    // you need this macro to get thing work proply
    //use this macro, or replace it with your own constrecteur but you must put init(this); on it
    INIT_CURD(Clients) // add CURD methods( Create, Update, Read, Delete)


    AUTO_PROPERTY(QString, first_name)
    AUTO_PROPERTY(QString, last_name)
    AUTO_PROPERTY(QDate, birth_date)
    AUTO_PROPERTY(char, gender)
    AUTO_PROPERTY(int, key)

public:
    //your public methods...
    //you can add init() function, to use it as your own constrecteur
    //you can add adjustRow() function, to get row adjust
        //for example : price * Quantity = totalPrice ;
        // instead of using trigger in each database (MYSQL, SQLITE3, ... )
private:
    //your private variables...


};

2- now you can init class and use predefine CURD methods from easyORM,go to main.cpp

    MyDatabase myDatabase;
    if(!myDatabase.initSQLITE3()) // you must call this method to make connection with database....
        return 1 ;
        
    
    
    Clients clients; 
    
    myDatabase.createTable(&clients); // create table 
    
    qDebug() << "tables: " << myDatabase.tables() ; // print all tables names
    
    // example of inserting random data ...
    clients.first_name("a") ; 
    clients.insert() ;
    clients.first_name("b") ; 
    clients.insert() ;
    clients.first_name("c") ; 
    clients.insert() ;
    
    //print all data
    for( int i = 0 ; i < clients.rowCount() ; i++ )
    {
        clients.setCurrentRow(i);
        qDebug() << "C++: " <<clients.first_name() ;
    }

3- you can use your class from QML, same as C++ side

    Component.onCompleted: {
        for( var i = 0 ; i < clients.rowCount() ; i++ )
        {
            // clients.setCurrentRow(i) will return JSON object to esy manipulate it from QML side
            // example 01 : no auto complete
            console.log(clients.setCurrentRow(i).first_name)
            
            // example 02: with auto complete
            clients.setCurrentRow(i)
            console.log(clients.first_name)
            console.log(clients.last_name)
        }
    }

advantage of easyORM

interacte with sql table from C++ or QML using same way .
auto complet when programming .
gerenate schema from C++ class and adapte schema for SQLITE3 or MYSQL .
you can add your own method to class to manupilate data before inserting and after reading data from table .
macro to generate getter and setter and property to access from qml .

Note

easyORM type convertion support only standard types like( int, QString, float, double, QDate, QDatetime, ... ) it doesn't support specifique type .....
method are named same as SQL querys ( select , where, insert, update, ... )
you should create class one and share pointeur to all your programme, or you can initiale your class and each time you will use it you need to call select(), to sync data between your objects.

Classes

easyORM.h contain CURD function for all child classes ( Create, Update, Read, Delete ) mydatabase.h contain generic function for database, (connecte, getAllTable, disconnecte, makeBackup... ) mypropertyhelper.h contain macro to make life easy when programing