1.5.1. /db/_design/design-doc

HEAD /{db}/_design/{ddoc}

返回包含有关指定设计文档的最少信息的HTTP头。

参见

HEAD /{db}/{docid}

GET /{db}/_design/{ddoc}

从URL返回使用设计文档名称指定的设计文档的内容,并从指定的数据库中返回。除非您请求特定修订,否则将始终返回文档的最新版本。

参见

GET /{db}/{docid}

PUT /{db}/_design/{ddoc}

这个 PUT 方法创建新的命名设计文档,或创建现有设计文档的新修订版。

设计文件在它们的领域和结构上有些一致。目前为:

  • 语言一串 ):定义 Query Server 处理设计文档功能
  • 选项对象 ):视图的默认选项
  • 过滤器对象 ): Filter functions 定义
  • 列表对象 ): List functions 定义。 已弃用。
  • 重写数组一串 ):重写规则定义。 已弃用。
  • 显示对象 ): Show functions 定义。 已弃用。
  • 更新对象 ): Update functions 定义
  • validate_doc_update一串 ): Validate document update 函数源
  • 意见对象 ): View functions 定义。
  • 自动更新 ( 布尔值 ):指示是否自动构建此设计文档中定义的索引。默认值为 true

注意,那是为了 filterslistsshowsupdates fields对象是函数名到字符串函数源代码的映射。为 views 除了值是具有 mapreduce (可选)也包含函数源代码的键。

参见

PUT /{db}/{docid}

DELETE /{db}/_design/{ddoc}

从数据库中删除指定的文档。必须提供当前(最新)版本,方法是使用 rev 参数指定修订。

参见

DELETE /{db}/{docid}

COPY /{db}/_design/{ddoc}

这个 COPY (非标准HTTP)将现有设计文档复制到新的或现有的设计文档。

假设磁盘上的视图索引是以视图定义的MD5散列命名的,并且 COPY 操作实际上不会更改该定义,复制的视图也不必重新构建。这两个视图将从磁盘上的同一索引提供服务。

参见

COPY /{db}/{docid}

1.5.2. /db/_design/design-doc/attachment

HEAD /{db}/_design/{ddoc}/{attname}

返回包含有关指定附件的最少信息的HTTP头。

参见

HEAD /{db}/{docid}/{attname}

GET /{db}/_design/{ddoc}/{attname}

返回与设计文档关联的文件附件。将返回关联附件的原始数据(就像访问静态文件一样)。

参见

GET /{db}/{docid}/{attname}

PUT /{db}/_design/{ddoc}/{attname}

将提供的内容作为附件上载到指定的设计文档。提供的附件名称必须是URL编码的字符串。

参见

PUT /{db}/{docid}/{attname}

DELETE /{db}/_design/{ddoc}/{attname}

删除指定设计文档的附件。

参见

DELETE /{db}/{docid}/{attname}

1.5.3. /db/_design/design-doc/_info

GET /{db}/_design/{ddoc}/_info

获取有关指定设计文档的信息,包括索引、索引大小、设计文档的当前状态以及关联的索引信息。

参数:
  • db -- 数据库名称
  • ddoc -- 设计文件名称
请求标头:
  • Accept --
    • application/json
    • text/plain
响应头:
  • Content-Type --
    • application/json
    • text/plain; charset=utf-8
响应JSON对象:
状态代码:
  • 200 OK -- 请求已成功完成

请求

GET /recipes/_design/recipe/_info HTTP/1.1
Accept: application/json
Host: localhost:5984

响应

HTTP/1.1 200 OK
Cache-Control: must-revalidate
Content-Length: 263
Content-Type: application/json
Date: Sat, 17 Aug 2013 12:54:17 GMT
Server: CouchDB (Erlang/OTP)

{
    "name": "recipe",
    "view_index": {
        "compact_running": false,
        "language": "python",
        "purge_seq": 0,
        "signature": "a59a1bb13fdf8a8a584bc477919c97ac",
        "sizes": {
          "active": 926691,
          "disk": 1982704,
          "external": 1535701
        },
        "update_seq": 12397,
        "updater_running": false,
        "waiting_clients": 0,
        "waiting_commit": false
    }
}

1.5.3.1. 查看索引信息

来自 :get:`/{{db}}/_design/{{ddoc}}/_info` 包含 view_index对象 )具有下一个结构的字段:

  • compact_running布尔 ):指示压缩例程当前是否正在视图上运行
  • sizes.active ):视图中实时数据的大小,以字节为单位
  • sizes.external ):视图内容的未压缩大小(以字节为单位)
  • sizes.file ):存储在磁盘上的视图大小(以字节为单位)
  • 语言一串 ):已定义视图的语言
  • purge_seq ):已处理的清除顺序
  • 签名一串 ):MD5设计文档视图的签名
  • update_seq / 一串 ):已编制索引的相应数据库的更新序列
  • updater_running布尔 ):指示视图当前是否正在更新
  • waiting_clients ):等待此设计文档中的视图的客户端数
  • waiting_commit布尔 ):指示是否存在需要处理的对基础数据库的未完成提交