我们可以在文档中存储任何数据内容,比如在订单文档中我们会存储订单状态、订单物品数量、订单金额等等内容。但是我们还需要存储一些和订单文档无关的内容,比如谁修改了订单文档、什么时候修改了订单文档等,这时就需要 Document Metadata (文档元数据,我们暂且这样翻译)登场了 。
Metadata 的存储格式和文档本身一样也是 Json,RavenDB 使用 Metadata 存储有关跟踪文档的几个重要信息:
类型 | 说明 |
---|---|
Raven-Clr-Type | .NET客户端 |
Raven-Java-Class | Java 客户端 |
Raven-Python-Class | Python客户端 |
除了使用 RavenDB 内置的 Metadata 属性外我们还可以自定义 Metadata 属性,比如我们要记录订单文档最后的修改人是谁,那么我们可以自定义 Metadata 属性 Last-Modified-By-User,代码如下:
using Raven.Client.Documents;
var store = new DocumentStore
{
Urls = new[] { "http://localhost:8080" },
Database = "Tasks"
};
store.Initialize();
using (var session = store.OpenSession())
{
var order = session.Load<Order>("orders/1-A");
//这里不会再次请求服务端,因为在我们查询数据文档时,
//Metadata 也会跟着一起返回给客户端
var metadata = session.Advanced.GetMetadataFor(order);
metadata["Last-Modified-By-User"] = "张三";
session.SaveChanges();
}
我们在 RavenDB Studio 中查看 orders/1-A 数据内容,我们可以看到自定一的 Metdata 属性已经存在与 Metadata 节点下了,如下图。
一般来说在实际开发中我们很少使用这种形式来操作 Metadata ,我们会使用事件的方式来操作,这将在后面的专栏里具体讲解,在这里你只需知道当前我们所讲的即可。
TIP:当我们在 RavenDB 文档中看到以 @ 开头的 Metadata 属性时,就说明这个属性是 RavenDB 保留给自己用的,因此我们在扩展 Metadata 属性时不能使用与之一样的属性名,我们自定义的 Metadata 属性需遵循帕斯卡命名法(PascalCase)或者Pascal-Case命名法(组成属性名的单词首字母大写,单词之间用 - 号分割),当然你也可以不按照这个建议。