# mysqlx

**Repository Path**: LinStr/mysqlx

## Basic Information

- **Project Name**: mysqlx
- **Description**: Python中类似MyBatis的MySQL数据库的操作框架，简单封装，声明式事务。
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://pypi.org/project/mysqlx
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-03-11
- **Last Updated**: 2024-03-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

##### Install
```shell
pip install mysqlx
```
##### Mapper file 

Create a mapper file in 'mapper' folder, you can named 'user_mapper.xml', like follow:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "https://gitee.com/summry/mysqlx/blob/master/dtd/mapper.dtd">
<mapper namespace="user">
	<select id="select_all">
	   select id, name, age from user
	</select>
	
	<select id="select_by_name">
	   select id, name, age from user where name = ?
	</select>
    
	<select id="select_by_name2">
	   select id, name, age from user where name = :name
	</select>
    
	<select id="select_include" include="select_all">
	   {{ select_all }}
	     {% if name -%}
		  where name = :name
    	 {%- endif -%}
	</select>
</mapper>
```

##### Usage Sample

```python
from mysqlx.orm import Model
from typing import List, Tuple, Mapping
from mysqlx import mapper, sql, db, dbx, init_db

@mapper(namespace='user')
def select_all(): List

@mapper(namespace='user')
def select_by_name(name: str): List

@mapper(namespace='user')
def select_by_name2(name: str): List

@mapper(namespace='user')
def select_include(name: str): List

@sql('select id, name, age from user where name = ?')
def query_by_name(name: str): List(Mapping)

@sql('select id, name, age from user where name = :name')
def query_by_name2(name: str): List(Mapping)

if __name__ == '__main__':
    init_db(host='127.0.0.1', port='3306', user='xxx', password='xxx', database='test', pool_size=5, show_sql=True, mapper_path='./mapper')
    
    users = select_all()
    # result:
    # (3, 'zhangsan', 15)
    # (4, 'lisi', 26)
    # (5, 'wangwu', 38)
    
    users = select_by_name('zhangsan')
    # result:
    # (3, 'zhangsan', 15)
    
    users = select_by_name2(name='zhangsan')
    # result:
    # (3, 'zhangsan', 15)
    
    users = select_include(name='zhangsan')
    # result:
    # (3, 'zhangsan', 15)
    
    users = query_by_name('zhangsan')
    # result:
    # {'id': 3, 'name': 'zhangsan', 'age': 15}
    
    users = query_by_name2(name='zhangsan')
    # result:
    # {'id': 3, 'name': 'zhangsan', 'age': 15}
    
    # you can use dbx execte mapper sql with full sql id: namespace join sql id
    users = dbx.select('user.select_all')  # 'user' is namespace, 'select_all' is sql id
    # result:
    # (3, 'zhangsan', 15)
    # (4, 'lisi', 26)
    # (5, 'wangwu', 38)
    
    users = dbx.select('user.select_by_name', name='zhangsan')
    # result:
    # (3, 'zhangsan', 15)
    
    # you can direct execte sql with db
    users = db.select('select id, name, age from user')
    # result:
    # (3, 'zhangsan', 15)
    # (4, 'lisi', 26)
    # (5, 'wangwu', 38)
    
    users = db.select('select id, name, age from user where name=?', 'zhangsan')
    # result:
    # (3, 'zhangsan', 15)
    
    # you can use orm to operate a single table
    class User(Model):
        __key__ = 'id'
        __table__ = 'user'

        def __init__(self, id: int = None, name: str = None, age: int = None):
            self.id = id
            self.name = name
            self.age = age
                  
    users = User.query()
    # result:
    # {'id': 3, 'name': 'zhangsan', 'age': 15}
    # {'id': 4, 'name': 'lisi', 'age': 26}
    # {'id': 5, 'name': 'wangwu', 'age': 38}
    
    users = User.query(name='zhangsan')
    # result:
    # {'id': 3, 'name': 'zhangsan', 'age': 15}
```
##### Transaction
```python
from mysqlx import with_transaction, transaction

@with_transaction
def test_transaction():
    insert_func(....)
    update_func(....)


def test_transaction2():
    with transaction():
        insert_func(....)
    	update_func(....)
```

You can generate model class with mysqlx-generator: https://pypi.org/project/mysqlx-generator

If you want to operate PostgreSQL database, may be you need PgSqlx: https://pypi.org/project/pgsqlx/