sqlx-batis is a sql executor for Python like MyBatis.
Project description
Mapper file
Create a mapper file in ‘mapper’ folder, you can named ‘person_mapper.xml’, like follow:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "https://gitee.com/summry/sqlx-batis/blob/master/dtd/mapper.dtd">
<mapper namespace="person">
<select id="select_all">
<![CDATA[
select id, name, age from person
]]>
</select>
<select id="select_by_name" include="select_all">
<![CDATA[
{{select_all}}
{% if name -%}
where name=:name
{%- endif -%}
]]>
</select>
</mapper>
Usage Sample
from sqlxbatis import dbx, Engin
from typing import List, Tuple, Mapping
from sqlxbatis.sql_mapper import mapper, sql
@mapper(namespace='person')
def select_all(): List
@mapper(namespace='person')
def select_by_name(name: str): List
@sql('select id, name, age from person')
def query_all(): List(Mapping)
@sql('select id, name, age from person where name=?')
def query_by_name(name: str): List(Mapping)
if __name__ == '__main__':
dbx.init_db(host='127.0.0.1', port='3306', person='xxx', password='xxx', database='test', show_sql=True, mapper_path='./mapper', engin=Engin.PostgreSQL)
persons = select_all()
# result:
# (3, 'zhangsan', 15)
# (4, 'lisi', 26)
# (5, 'wangwu', 38)
persons = select_by_name(name='zhangsan')
# result:
# (3, 'zhangsan', 15)
persons = query_all()
# result:
# {'id': 3, 'name': 'zhangsan', 'age': 15}
# {'id': 4, 'name': 'lisi', 'age': 26}
# {'id': 5, 'name': 'wangwu', 'age': 38}
persons = query_by_name('zhangsan')
# result:
# {'id': 3, 'name': 'zhangsan', 'age': 15}
# you can use dbx execte 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)
Transaction
from sqlxbatis import with_transaction, transaction
@with_transaction
def test_transaction():
insert_func(....)
update_func(....)
def test_transaction2():
with transaction():
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/sqlx-exec
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sqlx-batis-0.0.3.tar.gz
(8.3 kB
view hashes)