一个优雅的 mysql ORM ，无须做模型映射，所有操作都同时提供同步、异步两种方式。
主页 | Github | PyPi | 微信 | 邮箱 | 捐赠
您可以通过 Github-Issues、微信 与我联系。
pip install coolmysql
本文将以最简洁的方式向你介绍核心知识，而不会让你被繁琐的术语所淹没。
import pymysql, aiomysql
from coolmysql import ORM, mc
class ORM_2(ORM):
def mkconn(self): # 定义同步连接器
return pymysql.connect(
host = 'localhost',
port = 3306,
user = 'root',
password = '123456789'
)
async def amkconn(self): # 定义异步连接器
return await aiomysql.connect(
host = 'localhost',
port = 3306,
user = 'root',
password = '123456789'
)
orm = ORM_2() # 账户ORM
db = orm['泉州市'] # 库ORM
sheet = db['希望小学'] # 表ORM
【增、删、改、查】的同步方法名称分别为：insert、delete、update、select 。
对应的异步方法名称为各同步方法名前加 a ，即：ainsert、adelete、aupdate、aselect 。
line1 = {'姓名': '小一', '年龄': 11, '性别': '男', '视力': 4.5, '签到日期': '2023-01-11'}
line2 = {'姓名': '小二', '年龄': 12, '性别': '男', '视力': 4.6, '签到日期': '2023-01-12'}
line3 = {'姓名': '小三', '年龄': 13, '性别': '女', '视力': 4.7, '签到日期': '2023-01-13'}
line4 = {'姓名': '小四', '年龄': 14, '性别': '女', '视力': 4.8, '签到日期': '2023-01-14'}
line5 = {'姓名': '小五', '年龄': 15, '性别': '男', '视力': 4.9, '签到日期': '2023-01-15'}
line6 = {'姓名': '小六', '年龄': 16, '性别': '女', '视力': 5.0, '签到日期': '2023-01-16'}
| 同步方式 | 异步方式 | |
|---|---|---|
| 增（1 条） | sheet.insert( line1 ) | await sheet.ainsert( line2 ) |
| 增（批量） | sheet.insert( line3, line4 ) | await sheet.ainsert( line5, line6 ) |
| 删 | sheet.delete( ) | await sheet.adelete( ) |
| 改 | sheet.update( {'年龄': 100} ) | await sheet.aupdate( {'年龄': 200} ) |
| 查 | sheet.select( ) | await sheet.aselect( ) |
查看分配到的主键：
r1 = sheet.insert( line1 )
r2 = await sheet.ainsert( line2 )
r1.lastrowid
r2.lastrowid
筛选【年龄>13，且视力≧4.6，且性别为女】的数据，并进行增删改查：
查询：sheet[mc.年龄 > 13][mc.视力 >= 4.6][mc.性别 == '女'].select( )
修改：sheet[mc.年龄 > 13][mc.视力 >= 4.6][mc.性别 == '女'].update( {'年级':'初一', '爱好':'画画,跳绳'} )
删除：sheet[mc.年龄 > 13][mc.视力 >= 4.6][mc.性别 == '女'].delete( )
| 代码 | 解释 |
|---|---|
| mc.年龄 > 10 | 大于 |
| mc.年龄 >= 10 | 大于或等于 |
| mc.年龄 < 10 | 小于 |
| mc.年龄 <= 10 | 小于或等于 |
| mc.年龄 == 10 | 等于 |
| mc.年龄 != 10 | 不等于 |
| mc.年级.isin( '初三', '高二' ) | 若字段值是传入值的成员，则符合 |
| mc.年龄.notin( 10, 30, 45 ) | 若字段值不是传入值的成员，则符合 |
| mc.姓名.re( '小' ) | 正则匹配 |
[mc.年龄 > 3][mc.年龄 < 100] | 交集（方式一） |
| [ (mc.年龄 > 3) & (mc.年龄 < 100) ] | 交集（方式二） |
[(mc.年龄<30) | (mc.年龄>30) | (mc.年龄==30) | (mc.年龄==None)] | 并集 |
| [ (mc.年龄 > 3) - (mc.年龄 > 100) ] | 差集 |
| [ ~(mc.年龄 > 100) ] | 补集 |
注：
1、isin、notin 的传入值都不必是同类型的数据，以 isin 为例：可以这样使用：mc.tag.isin( 3, 3.5, '学生', None ) ，传入值含有 int、float、str、NoneType 等多种类型。
2、成员运算符未传入任何值时的处理方式：
| 代码 | 处理方式 |
|---|---|
| mc.年级.isin( ) | 所有数据都 不符合 |
| mc.年级.notin( ) | 所有数据都 符合 |
3、四种集合运算可以相互嵌套，且可以无限嵌套。
筛选【年龄>13或视力≧4.6、且姓名含有‘小’、且喜欢足球但不喜欢画画】的数据：
查询：sheet[(mc.年龄>13) | (mc.视力>=4.6)][mc.姓名.re('小')][mc.爱好.re('足球') - mc.爱好.re('画画')].select( )
修改：sheet[(mc.年龄>13) | (mc.视力>=4.6)][mc.姓名.re('小')][mc.爱好.re('足球') - mc.爱好.re('画画')].update( {'年级':'初三'} )
删除：sheet[(mc.年龄>13) | (mc.视力>=4.6)][mc.姓名.re('小')][mc.爱好.re('足球') - mc.爱好.re('画画')].delete( )
MySQL 支持各种特殊的字段名，如：数字、符号、emoji 表情，这些字符在 Python 中不是合法变量名，因此使用 mc.1、mc.+ 等格式会报错，可用 mc['1']、mc['+']、mc['👈'] 这种格式代替。
1、切片格式为 [start: stop: step] ，start 表示从哪条开始，stop 表示到哪条停止，step 表示步长。
2、start 和 stop
3、step
: step ，即：[start: stop] 等价于 [start: stop: 1] 。sheet[过滤器]...[过滤器][:].select() # 查询符合条件的全部数据
sheet[过滤器]...[过滤器][:].delete() # 删除符合条件的全部数据
sheet[过滤器]...[过滤器][:].update({'年级':'初一'}) # 修改符合条件的全部数据
sheet[过滤器]...[过滤器][1].select() # 查询符合条件的第1条
sheet[过滤器]...[过滤器][1].delete() # 删除符合条件的第1条
sheet[过滤器]...[过滤器][1].update({'年级':'初一'}) # 修改符合条件的第1条
sheet[过滤器]...[过滤器][3:7].select() # 查询符合条件的第3~7条
sheet[过滤器]...[过滤器][3:7].delete() # 删除符合条件的第3~7条
sheet[过滤器]...[过滤器][3:7].update({'年级':'初一'}) # 修改符合条件的第3~7条
sheet[过滤器]...[过滤器][3:7:2].select() # 查询符合条件的第3、5、7条
sheet[过滤器]...[过滤器][3:7:2].delete() # 删除符合条件的第3、5、7条
sheet[过滤器]...[过滤器][3:7:2].update({'年级':'初一'}) # 修改符合条件的第3、5、7条
值得注意的地方： [3: 8: 2] 操作第 3、5、7 条，而 [8: 3: 2] 操作第 8、6、4 条。
更多示例：
[:] # 所有数据
[1:-1] # 所有数据
[-1:1] # 所有数据（逆序）
[1:] # 所有数据
[:1000] # 第1条 ~ 第1000条
[:-1000] # 第1条 ~ 倒数第1000条
[100:200] # 第100条 ~ 第200条
[200:100] # 第200条 ~ 第100条
[-300:-2] # 倒数第300条 ~ 倒数第2条
[50:-2] # 第50条 ~ 倒数第2条
[250:] # 第250条 ~ 最后1条
[-250:] # 倒数第250条 ~ 最后1条
[1] # 第1条
[-1] # 最后1条
[::3] # 以3为间距, 间隔操作所有数据
[100:200:4] # 以4为间距, 间隔操作第100条 ~ 第200条
变量 mc 无字段提示功能，输入‘mc.’后，编辑器不会提示可选字段。
为了获得字段提示功能，可自建一个‘mc2’：
class mc2(mc):
姓名 = 年龄 = 签到日期 = 年级 = 爱好 = None
await sheet[mc.姓名 == '小王'][mc2.年龄 > 10].aselect()
注：
1、mc2 与 mc 用法完全一致，可混用。
2、mc2 设置字段提示后，仅具备提示效果，而不产生任何实际约束。
对所有年级为“高一”的数据，优先按年龄降序，其次按姓名升序，排序后返回第 2~4 条数据：
sheet[mc.年级=='高一'].order(年龄=False, 姓名=True)[2:4].select()
有趣的，以下两行代码的返回结果相同：
sheet[mc.年级=='高一'].order(年龄=True)[1:-1].select()
sheet[mc.年级=='高一'].order(年龄=False)[-1:1].select()
解释：order(年龄=False) 表示按年龄降序，[-1:1] 表示逆序切片，产生了类似‘负负得正’的效果。
注：
1、筛选器、切片器、排序器、限定字段器的位置可任意，位置不影响其效果。当然，它们都应该在 sheet 之后，且在 select/update/delete 之前。
2、可反复排序，select/update/delete 时是根据最后一次指定的顺序提取数据。以下代码最终是按年龄降序后提取数据：
sheet.order(年龄=True, 姓名=False).order(年龄=False).select()
3、若想取消排序，则再次调用 order 方法，但不传入任何值。
sheet.order(年龄=True, 姓名=False).order().select()
只返回姓名、年龄这两个字段：
sheet[mc.年级=='高一']['姓名','年龄'].select()
注：
1、限定字段只对 select 有作用，对 update/delete 无作用但不会报错。
2、筛选器、切片器、排序器、限定字段器的位置可任意，位置不影响其效果。当然，它们都应该在 sheet 之后，且在 select/update/delete 之前。
3、可反复限定字段，查询时是根据最后一次指定的字段提取数据。以下代码返回结果中只有‘年龄’字段：
sheet[mc.年级=='高一']['姓名']['年龄'].select()
4、若想恢复提取全部字段，则限定字段为 '*' ，'*' 即代表“全部字段”。
sheet[mc.年级=='高一']['姓名']['*'].select()
| 同步方式 | 异步方式 | |
|---|---|---|
| 统计库的数量 | orm.len( ) | await orm.alen( ) |
| 统计表的数量 | db.len( ) | await db.alen( ) |
| 统计行的数量 | sheet.len( ) | await sheet.alen( ) |
| 统计符合条件的行的数量 | sheet[ mc.age > 8 ].len( ) | await sheet[ mc.age > 8 ].alen( ) |
| 获取库名清单 | orm.get_db_names( ) | await orm.aget_db_names( ) |
| 获取表名清单 | db.get_sheet_names( ) | await db.aget_sheet_names( ) |
| 获取主键 | sheet.get_pk( ) | await sheet.aget_pk( ) |
# 同步方式迭代
for db in orm:
for sheet in db:
print(sheet.sheet_name)
# 异步方式迭代
async for db in orm:
async for sheet in db:
print(sheet.sheet_name)
对 orm、db、sheet 中的任意一个调用 close( ) 方法即可。
关闭 mysql 连接后，orm、db、sheet 都可以再使用。当再次使用时，ORM 会自动重新连接。
data, cursor = sheet.execute('select 姓名 from 希望小学 limit 1')
data # >>> [{'姓名': '小一'}]
data, cursor = sheet.execute('update 希望小学 set 爱好="编程" limit 3')
cursor.rowcount # >>> 3
data, cursor = sheet.execute("delete from 希望小学 limit 2")
cursor.rowcount # >>> 2
data, cursor = sheet.executemany( 'insert into 希望小学(姓名, 年龄) values (%s, %s)', [('小七', 17), ('小八', 18)] )
cursor.lastrowid # >>> 8
data = {
2: {'姓名':'xiao二', '年龄':20},
3: {'年级':'三年级'},
4: {'id':400, '视力':4.0}
}
sheet.update_by_pk(data)
def handler(row: dict):
row['年龄'] += 1 # 年龄统一加1岁
if row['爱好'] == '打篮球':
row['身高'] = 180
elif row['爱好'] == '玩手机':
row['视力'] = 1.8
row['姓名'] = row['姓名'].replace('小', 'xiao')
sheet[mc.年龄>11][:].apply(handler) # 修改符合条件的所有数据
sheet[mc.年龄>11][2:-2].apply(handler) # 修改符合条件的第2条~倒数第2条
sheet[mc.年龄>11][2].apply(handler) # 修改符合条件的第2条数据
注：
1、传递给 apply 方法的函数必须接收且仅接收 1 个参数，参数名可以不是‘row’。
2、可只提取需要的字段以提升性能。比如在上例中，handler 函数只使用到年龄、爱好、姓名这3个字段，可改为 sheet[mc.年龄>11]['年龄', '爱好', '姓名'][:].apply(handler) 以提高性能。
3、ORM 会自动对比修改前与修改后的数据差异，只提交差异部分到数据库。
在查询、删除、修改的筛选条件中调用 year 函数
from coolmysql import mf
sheet[mf.year('签到日期') == 2023][:].select()
sheet[mf.year('签到日期') == 2029][:].delete()
sheet[mf.year('签到日期') == 2023][:].update({'性别':'女'})
在修改中作为新值
sheet[:].update({'备注': '签到日期'}) # 修改为'签到日期'这个字符串
sheet[:].update({'备注': mc.签到日期}) # 修改为各自的'签到日期'字段的值
sheet[:].update({'备注': mf.year('签到日期')}) # 修改为各自的'签到日期'字段的值经year处理后的值
使用该语法可调用mysql的任意函数。
ORM 已添加了（20几个）mysql 常用函数的函数名提示，输入‘mf.’后，编辑器会提示可选函数名。如有需要，可添加更多提示：
class mf2(mf):
reverse = length = lower = upper = None
sheet[mf2.reverse('姓名') == '二小'][:].select()
注：
1、mf2 与 mf 用法完全一致，可混用。
2、mf2 设置函数名提示后，仅具备提示效果，而不产生任何实际约束。
FAQs
一个优雅的 mysql ORM ，无须做模型映射，所有操作都同时提供同步、异步两种方式。
We found that coolmysql demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.