数据存储层技术文档

1. 安装指南

使用pip安装

sudo pip install datastore

使用setuptools安装

sudo easy_install datastore

从源代码安装

git clone https://github.com/datastore/datastore/
cd datastore
sudo python setup.py install

2. 项目使用说明

datastore项目提供了一个用于数据存储和数据库访问的通用抽象层。它的目的是以数据存储无关的方式进行应用程序开发，允许无缝地替换数据存储而无需修改应用程序代码。这样，用户可以根据不同的需求利用不同的数据存储，而无需在应用程序的生命周期中承诺使用单一的数据存储。

以下是使用datastore的基本示例：

import datastore.core
import datastore.DictDatastore

# 创建数据存储实例
ds = datastore.DictDatastore()

# 创建一个键
hello = datastore.Key('hello')

# 存储数据
ds.put(hello, 'world')

# 检查键是否存在
print(ds.contains(hello))  # 输出：True

# 获取数据
print(ds.get(hello))  # 输出：world

# 删除数据
ds.delete(hello)

# 再次获取数据，应该返回None
print(ds.get(hello))  # 输出：None

3. 项目API使用文档

datastore API专注于简洁和优雅。只有四个核心方法必须实现（get、put、delete、query）。

get(key)

返回由key命名的对象，如果不存在，则返回None。

参数：

• key：命名要检索的对象的键

返回值：

• 对象或None

put(key, value)

存储名为key的对象value。如何序列化和存储对象取决于底层的数据存储。建议使用简单的对象（字符串、数字、列表、字典）。

参数：

• key：命名要存储的value的键
• value：要存储的对象

delete(key)

删除名为key的对象。

参数：

• key：命名要删除的对象的键

query(query)

返回与query中表达的标准匹配的对象的可迭代对象。不同数据存储之间的最大区别将是查询的实现。所有数据存储必须实现查询，即使使用查询的最坏情况场景，具体请参阅Query类。

参数：

• query：描述要返回的对象的标准查询对象

返回值：

• 与标准匹配的所有对象的可迭代游标

Key

Key代表对象的唯一标识符。我们的键方案受到文件系统和Google App Engine键模型的启发。

键在整个系统中应该是唯一的，并且是分层的，包含越来越具体的命名空间。因此，键可以被看作是其他键的“子键”或“祖先键”。

例如：

Key('/Comedy')
Key('/Comedy/MontyPython')
Key('/Comedy/MontyPython/Actor:JohnCleese')
Key('/Comedy/MontyPython/Sketch:CheeseShop')
Key('/Comedy/MontyPython/Sketch:CheeseShop/Character:Mousebender')

4. 项目安装方式

请参考上述“安装指南”部分，根据您的需要选择合适的方式来安装datastore项目。