11.JSON数据类型支持
概述
最近,所有主流数据库系统中都增加了对JSON数据类型的支持,JSON支持引入了NoSQL数据库中常见的动态数据结构,通常在处理高度变化的数据或难以预测准确的数据结构时使用。
Pony允许使用Python语法来处理存储在数据库中的JSON数据。
声明一个JSON属性
在Pony中声明一个JSON属性时,你应该使用Json类型,这个类型可以从pony.orm
包中导入。
from pony.orm import *
db = Database()
class Product(db.Entity):
id = PrimaryKey(int, auto=True)
name = Required(str)
info = Required(Json)
tags = Optional(Json)
db.bind('sqlite', ':memory:', create_db=True)
db.generate_mapping(create_tables=True)
Product
实体中的info
属性被声明为Json,这使得我们可以为不同的产品类型拥有不同的JSON结构,并对这些数据进行查询。
给JSON属性赋值
通常情况下,JSON结构包含了字典和包含简单类型的列表的组合,如数字、字符串和布尔等。
让我们用一个简单的JSON结构创建几个对象:
p1 = Product(name='Samsung Galaxy S7 edge',
info={
'display': {
'size': 5.5,
},
'battery': 3600,
'3.5mm jack': True,
'SD card slot': True
'colors': ['Black', 'Grey', 'Gold'],
},
tags=['Smartphone', 'Samsung'])
p2 = Product(name='iPhone 6s',
info={
'display': {
'size': 4.7,
'resolution': [750, 1334],
'multi-touch': True
},
'battery': 1810,
'3.5mm jack': True,
'colors': ['Silver', 'Gold', 'Space Gray', 'Rose Gold']
},
tags=['Smartphone', 'Apple', 'Retina'])
在Python代码中,一个JSON结构用标准的Python字典(dict)和列表(list)来表示。
在我们的例子中,info
属性是用dict
分配的,tags
属性保留了一个标签的列表,这些属性将被序列化为JSON,并在提交时存储在数据库中。
读取JSON属性
你可以像其他实体属性一样读取一个JSON属性。
>>> Product[1].info
{'battery': 3600, '3.5mm jack': True, 'colors': ['Black', 'Grey', 'Gold'], 'display': 5.5}
一旦从数据库中提取出JSON属性,它就会被反序列化,并以dicts和lists的组合来表示,你可以使用标准的 Python dict 和 list API 来处理这个值。
>>> Product[1].info['colors']
['Black', 'Grey', 'Gold']
>>> Product[1].info['colors'][0]
'Black'
>>> 'Black' in Product[1].info['colors']
True
修改JSON属性
对于修改 JSON 属性值,你也可以使用标准的 Python list 和 dict API。
>>> Product[1].info['color'].append('Silver')
>>> Product[1].info['color']
['Black', 'Grey', 'Gold', 'Silver']
现在,在提交时,这些变化将被存储在数据库中,为了跟踪JSON结构中的修改,Pony使用了自己的dict和list实现,它继承了标准Python的dict和list。
下面是几个例子,说明如何修改JSON值:
p = Product[1]
#分配一个新的值
p.info['display']['size'] = 4.7
# 弹出一个dict值
display_size = p.info['display'].pop('size')
# 使用del删除一个dict键
del p.info['display']
# 添加一个dict键
p.info['display']['resolution'] = [1440, 2560]
# 删除一个列表项目
del p.info['color'][0]
# 替换一个列表项目
p.info['color'][1] =['White']
# 替换一些列表中的项目
p.info['color'][1:] = ['White']
上面的所有操作都是对属性、列表和字典的常规Python操作。
查询JSON结构
数据库中的Native JSON支持不仅可以读取和修改结构化数据,还可以进行查询。
这是一个非常强大的功能--查询使用相同的语法并在相同的ACID事务处理环境中运行,同时提供关系型数据库内部文档存储的NoSQL功能。
Pony允许通过JSON子元素来筛选对象,要访问JSON子元素,Pony会构造JSON路径表达式,然后在SQL查询中使用。
#显示尺寸大于5的产品
Product.select(lambda p: p.info['display']['size'] > 5)
为了指定数值,你可以使用参数。
x = 2048
#宽度分辨率>=x的产品
Product.select(lambda p: p.info['display']['resolution'][0] >= x)
在MySQL, PostgreSQL, CockroachDB和SQLite中,也可以在JSON路径表达式中使用参数。
index = 0
Product.select(lambda p: p.info['display']['resolution'][index] < 2000)
key = 'display'
Product.select(lambda p: p.info[key]['resolution'][index]>1000)
Oracle不支持JSON路径内的参数,在Oracle中,你只能使用常数键。
对于JSON数组,你可以计算长度。
#有2个以上标签的产品
Product.select(lambda p: len(p.info['tags']) > 2)
另一个查询例子是检查一个字符串键是否是JSON dict或数组的一部分。
#有指定分辨率的产品
Product.select(lambda p: 'resolution'in p.info['display'])
#黑色产品
Product.select(lambda p: 'Black' in p.info['color']])
当你将JSON子元素与None进行比较时,在以下情况下,它将被评估为True:
- 当子元素包含JSON空值时
- 当子元素不存在时
Product.select(lambda p: p.info['SD card slot'] is None)
你可以测试JSON子元素的真值:
# products with multi-touch displays
select(p for p in Product if p.info['display']['multi-touch'])
在Python中,以下值被当作false处理:None、0、False、空字符串、空 dict 和空 list
。
对于应用于 JSON 结构的条件,Pony 保留了这个行为,另外,如果没有找到JSON路径,则会被评价为false。
在之前的例子中,我们在查询条件中使用了JSON结构。但也可以检索到JSON结构或提取其部分作为查询结果。
select(p.info['display'] for p in Product)
当以这种方式检索JSON结构时,它们不会与实体实例链接,这意味着修改这样的JSON结构不会被保存到数据库中,只有当你选择一个对象并修改其属性时,Pony才会跟踪JSON的变化。
MySQL和Oracle允许在JSON路径中使用通配符,Pony通过使用特殊语法支持通配符。
- [...]表示 任何字典元素
- [:] 表示 任何列表项目
下面是一个查询示例:
select(p.info['display']][...] for p in Product)
这种查询的结果将是一个JSON子元素的数组,就目前数据库中支持JSON的情况来看,通配符只能在生成器的表达式部分使用。
数据库中的JSON支持
为了在数据库中存储JSON,Pony使用以下类型:
- SQLite - TEXT
- PostgreSQL和CockroachDB - JSONB (二进制JSONB)
- MySQL - JSON(二进制JSON,尽管它的名字中没有 "B",但它是二进制JSON )
- Oracle - CLOB
从V3.9开始,SQLite提供了JSON1扩展模块,这个扩展模块提高了处理JSON查询时的性能,尽管Pony即使没有这个模块,也可以在SQLite中处理JSON。