2. JSON结构引用

下面的附录提供了对您可以提供给CouchDB或返回请求的所有JSON结构的快速参考。

2.1. 所有数据库文档

描述

total_rows

数据库/视图中的文档数

抵消

文档列表开始位置的偏移量

更新序列(可选)

数据库的当前更新序列

排 [数组]

文档对象数组

2.2. 批量文档响应

描述

文档 [数组]

批量单据退回单据

身份证件

文档ID

错误

错误类型

原因

带扩展原因的错误字符串

2.3. 批量文件

描述

文档 [数组]

批量文档文档

_id(可选)

文档ID

_rev(可选)

修订ID(更新现有文档时)

_已删除(可选)

是否应删除文档

2.4. 更改数据库的信息

描述

last_seq

上次更新序列

悬而未决的

源中剩余项的计数

结果 [数组]

对数据库所做的更改

SEQ

更新序列

身份证件

文档ID

变化 [数组]

此文档的逐字段更改列表

2.5. CouchDB文档

描述

_id(可选)

文档ID

_rev(可选)

修订ID(更新现有文档时)

2.6. CouchDB错误状态

描述

身份证件

文档ID

错误

错误类型

原因

带扩展原因的错误字符串

2.7. CouchDB数据库信息对象

描述

db_name

数据库的名称。

committed_update_seq

提交的更新数。

doc_count

数据库中的文档数。

doc_del_count

删除的文档数。

compact_running

如果数据库压缩例程在此数据库上运行,则设置为true。

disk_format_version

数据存储在硬盘上时使用的物理格式的版本。

disk_size

存储在磁盘上的数据大小(以字节为单位)。计算中不包括视图索引。

instance_start_time

时间戳,指示打开数据库的时间,从纪元开始以微秒表示。

purge_seq

数据库上的清除操作数。

update_seq

数据库的当前更新序列。

2.8. 设计文件

描述

_id

设计文件ID

_rev

设计文件修订

意见

视图

视图名称

视图定义

地图

视图的映射函数

减少(可选)

减少查看函数

2.9. 设计文件信息

描述

名称

设计文件名称/ID

view_index

视图索引

compact_running

指示压缩例程当前是否正在视图上运行

disk_size

存储在磁盘上的视图大小(以字节为单位)

语言

定义视图的语言

purge_seq

已处理的清除顺序

签名

MD5设计文件的视图签名

update_seq

已编制索引的相应数据库的更新序列

updater_running

指示视图当前是否正在更新

waiting_clients

等待此设计文档中的视图的客户端数

waiting_commit

指示是否存在需要处理的对基础数据库的未完成提交

2.10. 带附件的文档

描述

_id(可选)

文档ID

_rev(可选)

修订ID(更新现有文档时)

_附件(可选)

文件附件

文件名

附件信息

content_type

MIME内容类型字符串

数据

文件附件内容,Base64编码

2.11. 活动任务列表

描述

任务 [数组]

活动任务

PID

进程ID

地位

任务状态消息

任务

任务名称

类型

操作类型

2.12. 复制设置

描述

来源

源数据库名称或URL。

目标

目标数据库名称或URL。

取消(可选)

取消复制。

检查点间隔(可选)

指定检查点间隔(毫秒)。

连续(可选)

将复制配置为连续。

创建目标(可选)

创建目标数据库。

文档ID(可选)

要同步的文档ID数组。

过滤器(可选)

筛选器函数的名称,格式为 ddoc/myfilter .

source_proxy(可选)

从源进行复制的代理服务器的地址。

目标代理(可选)

代理服务器的地址,应通过该地址复制到目标。

查询参数(可选)

传递给筛选器函数的查询参数;该值应为包含参数作为成员的文档。

选择器(可选)

选择复制中包含的文档。与使用相比,此选项提供了性能优势 filter 选择权。

自以下(可选)

开始复制的顺序。

使用检查点(可选)

是否使用复制检查点。

2.13. 复制状态

描述

好啊

复制状态

session_id

唯一会话ID

source_last_seq

从源数据库读取的最后一个序列号

历史 [数组]

复制历史记录

session_id

此复制操作的会话ID

recorded_seq

上次记录的序列号

docs_read

读取的文档数

docs_written

写入目标的文档数

doc_write_failures

文档写入失败数

start_time

复制操作开始的日期/时间

start_last_seq

更改流中的第一个序列号

end_time

复制操作完成的日期/时间

end_last_seq

更改流中的最后一个序列号

missing_checked

检查的丢失文档数

missing_found

找到的丢失文档数

2.14. 请求对象

描述

身体

请求正文数据为 string . 如果请求方法是 GET 此字段包含值 "undefined" . 如果方法是 DELETEHEAD 值是 "" (空字符串)。

曲奇饼干

Cookies object .

形式

表格数据 object . 如果 Content-Type 标题是 application/x-www-form-urlencoded .

报头

请求头 object .

身份证件

请求的文档id string 如果指定或 null 否则。

信息

Database information

方法

请求方法为 stringarray . 字符串值是作为以下之一的方法: HEADGETPOSTPUTDELETEOPTIONSTRACE . 否则它将被表示为一个字符代码数组。

路径

请求的路径部分的列表。

同龄人

请求源IP地址。

查询

URL查询参数 object . 请注意,不支持多个键,最后一个键值禁止使用其他键。

requested_path

请求的实际节的路径。

raw_path

原始请求路径 string .

塞科比

安全对象 .

用户CTX

用户上下文对象 .

UUID

由配置文件中的指定算法生成的UUID。

{
    "body": "undefined",
    "cookie": {
        "AuthSession": "cm9vdDo1MDZBRjQzRjrfcuikzPRfAn-EA37FmjyfM8G8Lw",
        "m": "3234"
    },
    "form": {},
    "headers": {
        "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
        "Accept-Charset": "ISO-8859-1,utf-8;q=0.7,*;q=0.3",
        "Accept-Encoding": "gzip,deflate,sdch",
        "Accept-Language": "en-US,en;q=0.8",
        "Connection": "keep-alive",
        "Cookie": "m=3234:t|3247:t|6493:t|6967:t|34e2:|18c3:t|2c69:t|5acb:t|ca3:t|c01:t|5e55:t|77cb:t|2a03:t|1d98:t|47ba:t|64b8:t|4a01:t; AuthSession=cm9vdDo1MDZBRjQzRjrfcuikzPRfAn-EA37FmjyfM8G8Lw",
        "Host": "127.0.0.1:5984",
        "User-Agent": "Mozilla/5.0 (Windows NT 5.2) AppleWebKit/535.7 (KHTML, like Gecko) Chrome/16.0.912.75 Safari/535.7"
    },
    "id": "foo",
    "info": {
        "committed_update_seq": 2701412,
        "compact_running": false,
        "db_name": "mailbox",
        "disk_format_version": 6,
        "doc_count": 2262757,
        "doc_del_count": 560,
        "instance_start_time": "1347601025628957",
        "purge_seq": 0,
        "sizes": {
          "active": 7580843252,
          "disk": 14325313673,
          "external": 7803423459
        },
        "update_seq": 2701412
    },
    "method": "GET",
    "path": [
        "mailbox",
        "_design",
        "request",
        "_show",
        "dump",
        "foo"
    ],
    "peer": "127.0.0.1",
    "query": {},
    "raw_path": "/mailbox/_design/request/_show/dump/foo",
    "requested_path": [
        "mailbox",
        "_design",
        "request",
        "_show",
        "dump",
        "foo"
    ],
    "secObj": {
        "admins": {
            "names": [
                "Bob"
            ],
            "roles": []
        },
        "members": {
            "names": [
                "Mike",
                "Alice"
            ],
            "roles": []
        }
    },
    "userCtx": {
        "db": "mailbox",
        "name": "Mike",
        "roles": [
            "user"
        ]
    },
    "uuid": "3184f9d1ea934e1f81a24c71bde5c168"
}

2.15. Request2对象

描述

身体

请求正文数据为 string . 如果请求方法是 GET 此字段包含值 "undefined" . 如果方法是 DELETEHEAD 值是 "" (空字符串)。

曲奇饼干

Cookies object .

报头

请求头 object .

方法

请求方法为 stringarray . 字符串值是作为以下之一的方法: HEADGETPOSTPUTDELETEOPTIONSTRACE . 否则它将被表示为一个字符代码数组。

路径

请求的路径部分的列表。

同龄人

请求源IP地址。

查询

URL查询参数 object . 请注意,不支持多个键,最后一个键值禁止使用其他键。

requested_path

请求的实际节的路径。

raw_path

原始请求路径 string .

塞科比

安全对象 .

用户CTX

用户上下文对象 .

2.16. 响应对象

描述

代码

HTTP状态代码 number .

json

JSON可编码 object . 隐式集合 Content-Type 收割台组件 application/json .

身体

原始响应文本 string . 隐式集合 Content-Type 收割台组件 text/html; charset=utf-8 .

Base64

Base64编码 string . 隐式集合 Content-Type 收割台组件 application/binary .

报头

响应头 object . Content-Type 此对象的头重写任何隐式分配的头。

停止

boolean 停止对视图结果行的迭代的信号(仅限列表函数)

警告

这个 bodybase64json 对象键相互重叠,最后一个获胜。由于键-值对象的大多数实现都不保留键顺序,或者如果它们混合在一起,可能会出现令人困惑的情况。尽量只使用其中一个。

注解

任何自定义属性都会使CouchDB引发内部异常。此外 Response object 可能是一个简单的字符串值,该值将隐式包装到 {{"body": ...}} 对象。

2.17. 返回带有详细修订信息的CouchDB文档

描述

_id(可选)

文档ID

_rev(可选)

修订ID(更新现有文档时)

_revs_info [数组]

CouchDB文档扩展修订信息

版次

完整修订字符串

地位

修订的状态

2.18. 返回带有修订信息的CouchDB文档

描述

_id(可选)

文档ID

_rev(可选)

修订ID(更新现有文档时)

_revisions

CouchDB文件修订

身份证 [数组]

有效修订ID数组,按相反顺序排列(最新的第一个)

开始

最新版本的前缀号

2.19. 带附件的返回文档

描述

_id(可选)

文档ID

_rev(可选)

修订ID(更新现有文档时)

_附件(可选)

文件附件

文件名

附件

树桩

指示附件是否为存根

content_type

MIME内容类型字符串

长度

附件数据的长度(字节)

revpos公司

本附件所在的版本

2.20. 安全对象

描述

管理员

具有管理员权限的角色/用户

角色 [数组]

具有父权限的角色列表

姓名 [数组]

具有父权限的用户列表

成员

具有非管理员权限的角色/用户

角色 [数组]

具有父权限的角色列表

姓名 [数组]

具有父权限的用户列表

{
    "admins": {
        "names": [
            "Bob"
        ],
        "roles": []
    },
    "members": {
        "names": [
            "Mike",
            "Alice"
        ],
        "roles": []
    }
}

2.21. 用户上下文对象

描述

分贝

提供的操作上下文中的数据库名称。

名称

用户名。

角色

用户角色列表。

{
    "db": "mailbox",
    "name": null,
    "roles": [
        "_admin"
    ]
}

2.22. 查看头部信息

描述

total_rows

视图中的文档数

抵消

文档列表开始位置的偏移量

{
    "total_rows": 42,
    "offset": 3
}