BatisX 2.2.4

A easy thread safe sql executor for Python like MyBatis with connection pool. It helps you automatically manage database connections and transactions. Support MySQL, PostgreSQL, SQLite etc.

Mapper file '''''''''''

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

.. code:: xml

   <?xml version="1.0" encoding="UTF-8"?>
   <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "https://gitee.com/summry/batisx/blob/master/dtd/mapper.dtd">
   <mapper namespace="person">
       <select id="select_all">
           select id, name, age from person
        </select>

        <select id="select_by_name">
           select id, name, age from person where name = ?
        </select>

        <select id="select_by_name2">
           select id, name, age from person where name = :name
        </select>

        <select id="select_include" include="select_all">
           {{ select_all }}
             {% if name -%}
              where name = :name
             {%- endif -%}
        </select>
   </mapper>

Usage Sample ''''''''''''

.. code:: python

from typing import List, Tuple, Mapping
from batisx import mapper, sql, dbx, init_db

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

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

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

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

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

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

if __name__ == '__main__':
    # init_db('test.db', driver='sqlite3', show_sql=True, debug=True, mapper_path='./mapper')
    # init_db("postgres://user:password@127.0.0.1:5432/testdb", driver='psycopg2', pool_size=5, mapper_path='./mapper')
    init_db(host='127.0.0.1', port='3306', user='xxx', password='xxx', database='test', pool_size=5, show_sql=True, mapper_path='./mapper')

    persons = select_all()
    # result:
    # (3, 'zhangsan', 15)
    # (4, 'lisi', 26)
    # (5, 'wangwu', 38)

    persons = select_by_name('zhangsan')
    # result:
    # (3, 'zhangsan', 15)

    persons = select_by_name2(name='zhangsan')
    # result:
    # (3, 'zhangsan', 15)

    persons = select_include(name='zhangsan')
    # result:
    # (3, 'zhangsan', 15)

    persons = query_by_name('zhangsan')
    # result:
    # {'id': 3, 'name': 'zhangsan', 'age': 15}

    persons = query_by_name2(name='zhangsan')
    # result:
    # {'id': 3, 'name': 'zhangsan', 'age': 15}
   
    # you can use dbx execute mapper sql with full sql id: namespace join sql id
    persons = dbx.select('person.select_all')  # 'person' is namespace, 'select_all' is sql id
    # result:
    # (3, 'zhangsan', 15)
    # (4, 'lisi', 26)
    # (5, 'wangwu', 38)

    persons = dbx.select('person.select_by_name', name='zhangsan')
    # result:
    # (3, 'zhangsan', 15)

    persons = dbx.sql('person.select_by_name').select(name='zhangsan')
    # result:
    # (3, 'zhangsan', 15)

    # you can direct execute sql with db
    effected_rowcount = db.table('person').insert(name='zhangsan', age=15)
    # 1

    primary_key = db.table('person').save(name='lisi', age=26)
    # 4

    effected_rowcount = db.insert(table='person', name='wangwu', age=38)
    # 1

    users = db.table('person').columns('id, name, age').select()
    # result:
    # (3, 'zhangsan', 15)
    # (4, 'lisi', 26)
    # (5, 'wangwu', 38)

    users = db.table('person').columns('id, name, age').where(name='zhangsan').query()
    # result:
    # [{'id': 3, 'name': 'zhangsan', 'age': 15}]

    users = db.table('person').columns('id, name, age').where(name__eq='zhangsan').query()
    # result:
    # [{'id': 3, 'name': 'zhangsan', 'age': 15}]

    persons = db.select('select id, name, age from person')
    # result:
    # (3, 'zhangsan', 15)
    # (4, 'lisi', 26)
    # (5, 'wangwu', 38)
    # (6, 'zhaoliu', 45)

    persons = db.query('select id, name, age from person name = :name', name='zhangsan')
    # result:
    # [{'id': 3, 'name': 'zhangsan', 'age': 15}]

    persons = db.sql('select id, name, age from person name = :name').query(name='zhangsan')
    # result:
    # [{'id': 3, 'name': 'zhangsan', 'age': 15}]

    persons = db.select('select id, name, age from person where name = ?', 'zhangsan')
    # result:
    # [(3, 'zhangsan', 15)]

Transaction '''''''''''

.. code:: python

    from batisx import trans

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


    def test_transaction2():
        with trans():
            insert_func(....)
            update_func(....)

If you want to operate MySQL database, may be you need MySqlx: https://pypi.org/project/mysqlx

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

If you just wanted a simple sql executor, may be you need sqlx-exec: https://pypi.org/project/sqlexecx