sqlitemap

sqlitemap

SQLite数据库的字典接口。

简介

…有一天，我需要一个嵌入式钥匙值商店来进行宠物项目，但没有找到“足够好”的实现。所以，我做了自己的。

这是标准SQLite3模块上的轻巧包装器。它为SQLite连接和SQLite表提供了标准的MutableMapping接口。

Connection

您可以创建一个Connection的实例，就好像是普通的sqlite3.connect调用：

 from sqlitemap import Connection

connection = Connection ( ':memory:' , ...)

它实现了上下文管理器接口，因此您可以with交易，就好像它是sqlite3.Connection一样。除了__setitem__外，它实现了MutableMapping[str, Collection] 。因此，您可以想象Connection作为藏品的词典与他们的名字完全兼而有之，并且几乎可以用正常的dict做所有您可以做的一切：

 from sqlitemap import Collection

# Collection is automatically created:
foo : Collection = connection [ 'foo' ]

# You can iterate over collection names:
names = list ( connection )

# Or even over collections:
collections = connection . values ()

# Drop collection:
del connection [ 'foo' ]

# Get number of collections:
len ( connection )

# Special one, to close the connection:
connection . close ()

在内部，收集是一个具有两列的表： key: str和value: bytes 。因此，您需要一些序列化将对象表示为字节字符串。默认情况下， sqlitemap使用标准json模块。如果有的话，它可以捡起ujson或orjson 。这些也可作为sqlitemap Extras提供： sqlitemap[ujson]和sqlitemap[orjson] 。

否则，您可以为编码器指定任何自定义Callable[[Any], bytes] ，并为解码器Callable[[bytes], Any] ：

 connection = Connection ( ':memory:' , dumps_ = custom_dumps , loads_ = custom_loads )

Collection

Collection还实现了上下文管理器接口以进行交易，并MutableMapping[str, Any] ：

设置项目

 with raises ( KeyError ):
    _ = collection [ 'foo' ]
collection [ 'foo' ] = 'bar'
assert collection [ 'foo' ] == 'bar'
collection [ 'foo' ] = 'qux'
assert collection [ 'foo' ] == 'qux'

key列是主要键。

检索钥匙

 assert list ( collection ) == []
collection [ 'foo' ] = 'bar'
assert list ( collection ) == [ 'foo' ]

检索值

 assert collection . values () == []
collection [ 'foo' ] = 'bar'
assert collection . values () == [ 'bar' ]

删除项目

 with raises ( KeyError ):
    del collection [ 'foo' ]
collection [ 'foo' ] = 42
del collection [ 'foo' ]
with raises ( KeyError ):
    del collection [ 'foo' ]

使用切片

Collection.__getitem__和Collection.__setitem__也支持切片作为论点。然后将切片start转换为key >= start子句， stop到key < stop和step到key LIKE step 。所有这些都与AND员结合使用。 Collection.__getitem__也ORDER BY key ，因此可以进行一些更复杂的查询：

 collection [ 'bar' ] = 1
collection [ 'foo' ] = 2
collection [ 'quw' ] = 3
collection [ 'qux' ] = 4
collection [ 'quy' ] = 5
collection [ 'quz' ] = 6
assert collection [ 'foo' :] == [ 2 , 3 , 4 , 5 , 6 ]
assert collection [: 'foo' ] == [ 1 ]
assert collection [:: 'qu%' ] == [ 3 , 4 , 5 , 6 ]
assert collection [ 'bar' : 'quz' : 'qu%' ] == [ 3 , 4 , 5 ]

这也与del collection [...]一起使用。它删除将使用相应的__getitem__调用将选择的行：

 collection [ 'bar' ] = 1
collection [ 'foo' ] = 2
collection [ 'quw' ] = 3
collection [ 'qux' ] = 4
collection [ 'quy' ] = 5
collection [ 'quz' ] = 6
del collection [ 'bar' : 'quz' : 'qu%' ]
assert list ( collection ) == [ 'bar' , 'foo' , 'quz' ]

控制交易

sqlitemap对控制交易没有什么特别的作用。为此，请参阅标准库文档。