/usr/share/couchdb/www/docs/json-structure.html is in couchdb-common 1.5.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 | <!--
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>11. JSON Structure Reference — Apache CouchDB 1.5 Documentation</title>
<link rel="stylesheet" href="_static/rtd.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.5.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="author" title="About these documents" href="about.html" />
<link rel="top" title="Apache CouchDB 1.5 Documentation" href="index.html" />
<link rel="next" title="12. Experimental Features" href="experimental.html" />
<link rel="prev" title="10.6. Local (non-replicating) Document Methods" href="api/local.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="http-api.html" title="HTTP API Reference"
>API Reference</a></li>
<li class="right" >
<a href="config-ref.html" title="Configuration Reference"
>Config Reference</a> |</li>
<li class="right" >
<a href="experimental.html" title="12. Experimental Features"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="api/local.html" title="10.6. Local (non-replicating) Document Methods"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Apache CouchDB 1.5 Documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="json-structure-reference">
<h1>11. JSON Structure Reference<a class="headerlink" href="#json-structure-reference" title="Permalink to this headline">¶</a></h1>
<p>The following appendix provides a quick reference to all the JSON structures
that you can supply to CouchDB, or get in return to requests.</p>
<div class="section" id="all-database-documents">
<h2>11.1. All Database Documents<a class="headerlink" href="#all-database-documents" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>total_rows</td>
<td>Number of documents in the database/view</td>
</tr>
<tr class="row-odd"><td>offset</td>
<td>Offset where the document list started</td>
</tr>
<tr class="row-even"><td>update_seq (optional)</td>
<td>Current update sequence for the database</td>
</tr>
<tr class="row-odd"><td>rows [array]</td>
<td>Array of document object</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="bulk-document-response">
<h2>11.2. Bulk Document Response<a class="headerlink" href="#bulk-document-response" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>docs [array]</td>
<td>Bulk Docs Returned Documents</td>
</tr>
<tr class="row-odd"><td>id</td>
<td>Document ID</td>
</tr>
<tr class="row-even"><td>error</td>
<td>Error type</td>
</tr>
<tr class="row-odd"><td>reason</td>
<td>Error string with extended reason</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="bulk-documents">
<h2>11.3. Bulk Documents<a class="headerlink" href="#bulk-documents" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>all_or_nothing (optional)</td>
<td>Sets the database commit mode to use
all-or-nothing semantics</td>
</tr>
<tr class="row-odd"><td>docs [array]</td>
<td>Bulk Documents Document</td>
</tr>
<tr class="row-even"><td>_id (optional)</td>
<td>Document ID</td>
</tr>
<tr class="row-odd"><td>_rev (optional)</td>
<td>Revision ID (when updating an existing
document)</td>
</tr>
<tr class="row-even"><td>_deleted (optional)</td>
<td>Whether the document should be deleted</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="changes-information-for-a-database">
<h2>11.4. Changes information for a database<a class="headerlink" href="#changes-information-for-a-database" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>last_seq</td>
<td>Last change sequence number</td>
</tr>
<tr class="row-odd"><td>results [array]</td>
<td>Changes made to a database</td>
</tr>
<tr class="row-even"><td>seq</td>
<td>Update sequence number</td>
</tr>
<tr class="row-odd"><td>id</td>
<td>Document ID</td>
</tr>
<tr class="row-even"><td>changes [array]</td>
<td>List of changes, field-by-field, for this
document</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="couchdb-document">
<h2>11.5. CouchDB Document<a class="headerlink" href="#couchdb-document" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>_id (optional)</td>
<td>Document ID</td>
</tr>
<tr class="row-odd"><td>_rev (optional)</td>
<td>Revision ID (when updating an existing
document)</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="couchdb-error-status">
<h2>11.6. CouchDB Error Status<a class="headerlink" href="#couchdb-error-status" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>id</td>
<td>Document ID</td>
</tr>
<tr class="row-odd"><td>error</td>
<td>Error type</td>
</tr>
<tr class="row-even"><td>reason</td>
<td>Error string with extended reason</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="couchdb-database-information-object">
<span id="dbinfo-object"></span><h2>11.7. CouchDB database information object<a class="headerlink" href="#couchdb-database-information-object" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>db_name</td>
<td>The name of the database.</td>
</tr>
<tr class="row-odd"><td>committed_update_seq</td>
<td>The number of committed update.</td>
</tr>
<tr class="row-even"><td>doc_count</td>
<td>A count of the documents in the specified
database.</td>
</tr>
<tr class="row-odd"><td>doc_del_count</td>
<td>Number of deleted documents</td>
</tr>
<tr class="row-even"><td>compact_running</td>
<td>Set to true if the database compaction
routine is operating on this database.</td>
</tr>
<tr class="row-odd"><td>disk_format_version</td>
<td>The version of the physical format used for
the data when it is stored on disk.</td>
</tr>
<tr class="row-even"><td>disk_size</td>
<td>Size in bytes of the data as stored on the
disk. Views indexes are not included in the
calculation.</td>
</tr>
<tr class="row-odd"><td>instance_start_time</td>
<td>Timestamp of when the database was opened,
expressed in microseconds since the epoch.</td>
</tr>
<tr class="row-even"><td>purge_seq</td>
<td>The number of purge operations on the
database.</td>
</tr>
<tr class="row-odd"><td>update_seq</td>
<td>The current number of updates to the
database.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="design-document">
<h2>11.8. Design Document<a class="headerlink" href="#design-document" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>_id</td>
<td>Design Document ID</td>
</tr>
<tr class="row-odd"><td>_rev</td>
<td>Design Document Revision</td>
</tr>
<tr class="row-even"><td>views</td>
<td>View</td>
</tr>
<tr class="row-odd"><td>viewname</td>
<td>View Definition</td>
</tr>
<tr class="row-even"><td>map</td>
<td>Map Function for View</td>
</tr>
<tr class="row-odd"><td>reduce (optional)</td>
<td>Reduce Function for View</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="design-document-information">
<h2>11.9. Design Document Information<a class="headerlink" href="#design-document-information" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>name</td>
<td>Name/ID of Design Document</td>
</tr>
<tr class="row-odd"><td>view_index</td>
<td>View Index</td>
</tr>
<tr class="row-even"><td>compact_running</td>
<td>Indicates whether a compaction routine is
currently running on the view</td>
</tr>
<tr class="row-odd"><td>disk_size</td>
<td>Size in bytes of the view as stored on disk</td>
</tr>
<tr class="row-even"><td>language</td>
<td>Language for the defined views</td>
</tr>
<tr class="row-odd"><td>purge_seq</td>
<td>The purge sequence that has been processed</td>
</tr>
<tr class="row-even"><td>signature</td>
<td>MD5 signature of the views for the design
document</td>
</tr>
<tr class="row-odd"><td>update_seq</td>
<td>The update sequence of the corresponding
database that has been indexed</td>
</tr>
<tr class="row-even"><td>updater_running</td>
<td>Indicates if the view is currently being
updated</td>
</tr>
<tr class="row-odd"><td>waiting_clients</td>
<td>Number of clients waiting on views from this
design document</td>
</tr>
<tr class="row-even"><td>waiting_commit</td>
<td>Indicates if there are outstanding commits
to the underlying database that need to
processed</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="document-with-attachments">
<h2>11.10. Document with Attachments<a class="headerlink" href="#document-with-attachments" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>_id (optional)</td>
<td>Document ID</td>
</tr>
<tr class="row-odd"><td>_rev (optional)</td>
<td>Revision ID (when updating an existing
document)</td>
</tr>
<tr class="row-even"><td>_attachments (optional)</td>
<td>Document Attachment</td>
</tr>
<tr class="row-odd"><td>filename</td>
<td>Attachment information</td>
</tr>
<tr class="row-even"><td>content_type</td>
<td>MIME Content type string</td>
</tr>
<tr class="row-odd"><td>data</td>
<td>File attachment content, Base64 encoded</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="list-of-active-tasks">
<h2>11.11. List of Active Tasks<a class="headerlink" href="#list-of-active-tasks" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>tasks [array]</td>
<td>Active Task</td>
</tr>
<tr class="row-odd"><td>pid</td>
<td>Process ID</td>
</tr>
<tr class="row-even"><td>status</td>
<td>Task status message</td>
</tr>
<tr class="row-odd"><td>task</td>
<td>Task name</td>
</tr>
<tr class="row-even"><td>type</td>
<td>Operation Type</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="replication-settings">
<span id="id1"></span><h2>11.12. Replication Settings<a class="headerlink" href="#replication-settings" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>source</td>
<td>Source database name or URL</td>
</tr>
<tr class="row-odd"><td>target</td>
<td>Target database name or URL</td>
</tr>
<tr class="row-even"><td>create_target (optional)</td>
<td>Creates the target database</td>
</tr>
<tr class="row-odd"><td>continuous (optional)</td>
<td>Configure the replication to be continuous</td>
</tr>
<tr class="row-even"><td>cancel (optional)</td>
<td>Cancels the replication</td>
</tr>
<tr class="row-odd"><td>doc_ids (optional)</td>
<td>Array of document IDs to be synchronized</td>
</tr>
<tr class="row-even"><td>proxy (optional)</td>
<td>Address of a proxy server through which
replication should occur</td>
</tr>
<tr class="row-odd"><td>since_seq (optional)</td>
<td>Sequence from which the replication should
start</td>
</tr>
<tr class="row-even"><td>filter (optional)</td>
<td>name of the filter function in the form of
ddoc/myfilter</td>
</tr>
<tr class="row-odd"><td>query_params (optional)</td>
<td>query parameter that are passed to the
filter function; value should be a document
containing parameters as members</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="replication-status">
<span id="id2"></span><h2>11.13. Replication Status<a class="headerlink" href="#replication-status" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>ok</td>
<td>Replication status</td>
</tr>
<tr class="row-odd"><td>session_id</td>
<td>Unique session ID</td>
</tr>
<tr class="row-even"><td>source_last_seq</td>
<td>Last sequence number read from source
database</td>
</tr>
<tr class="row-odd"><td>history [array]</td>
<td>Replication History</td>
</tr>
<tr class="row-even"><td>session_id</td>
<td>Session ID for this replication operation</td>
</tr>
<tr class="row-odd"><td>recorded_seq</td>
<td>Last recorded sequence number</td>
</tr>
<tr class="row-even"><td>docs_read</td>
<td>Number of documents read</td>
</tr>
<tr class="row-odd"><td>docs_written</td>
<td>Number of documents written to target</td>
</tr>
<tr class="row-even"><td>doc_write_failures</td>
<td>Number of document write failures</td>
</tr>
<tr class="row-odd"><td>start_time</td>
<td>Date/Time replication operation started</td>
</tr>
<tr class="row-even"><td>start_last_seq</td>
<td>First sequence number in changes stream</td>
</tr>
<tr class="row-odd"><td>end_time</td>
<td>Date/Time replication operation completed</td>
</tr>
<tr class="row-even"><td>end_last_seq</td>
<td>Last sequence number in changes stream</td>
</tr>
<tr class="row-odd"><td>missing_checked</td>
<td>Number of missing documents checked</td>
</tr>
<tr class="row-even"><td>missing_found</td>
<td>Number of missing documents found</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="request-object">
<span id="id3"></span><h2>11.14. Request object<a class="headerlink" href="#request-object" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>body</td>
<td>Request body data as <cite>string</cite>.
If request method is <cite>GET</cite> method contains
this field contains <tt class="docutils literal"><span class="pre">"undefined"</span></tt> value,
while if <cite>DELETE</cite> or <cite>HEAD</cite> value is <tt class="docutils literal"><span class="pre">""</span></tt>
(empty string)</td>
</tr>
<tr class="row-odd"><td>cookie</td>
<td>Cookies <cite>object</cite>.</td>
</tr>
<tr class="row-even"><td>form</td>
<td>Form data <cite>object</cite>.
Contains decoded body as key-value pairs if
<cite>Content-Type</cite> header was
<tt class="docutils literal"><span class="pre">application/x-www-form-urlencoded</span></tt>.</td>
</tr>
<tr class="row-odd"><td>headers</td>
<td>Request headers <cite>object</cite>.</td>
</tr>
<tr class="row-even"><td>id</td>
<td>Requested document id <cite>string</cite> if it was
specified or <tt class="docutils literal"><span class="pre">null</span></tt> otherwise.</td>
</tr>
<tr class="row-odd"><td>info</td>
<td><a class="reference internal" href="#dbinfo-object"><em>Database information</em></a></td>
</tr>
<tr class="row-even"><td>method</td>
<td>Request method as <cite>string</cite> or <cite>array</cite>.
String value is method is one of: <cite>HEAD</cite>,
<cite>GET</cite>, <cite>POST</cite>, <cite>PUT</cite>, <cite>DELETE</cite>, <cite>OPTIONS</cite>,
and <cite>TRACE</cite>, otherwise it will be
represented as array of char codes.</td>
</tr>
<tr class="row-odd"><td>path</td>
<td>List of requested path sections.</td>
</tr>
<tr class="row-even"><td>peer</td>
<td>Request source IP address.</td>
</tr>
<tr class="row-odd"><td>query</td>
<td>URL query parameters <cite>object</cite>.
Note that multiple keys not supported and
last key value suppress others.</td>
</tr>
<tr class="row-even"><td>requested_path</td>
<td>List of actual requested path section.</td>
</tr>
<tr class="row-odd"><td>raw_path</td>
<td>Raw requested path <cite>string</cite>.</td>
</tr>
<tr class="row-even"><td>secObj</td>
<td><a class="reference internal" href="#security-object"><em>Security Object</em></a>.</td>
</tr>
<tr class="row-odd"><td>userCtx</td>
<td><a class="reference internal" href="#userctx-object"><em>User Context Object</em></a>.</td>
</tr>
<tr class="row-even"><td>uuid</td>
<td>Generated UUID by specified algorithm in
config file.</td>
</tr>
</tbody>
</table>
<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"body"</span><span class="o">:</span> <span class="s2">"undefined"</span><span class="p">,</span>
<span class="s2">"cookie"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"AuthSession"</span><span class="o">:</span> <span class="s2">"cm9vdDo1MDZBRjQzRjrfcuikzPRfAn-EA37FmjyfM8G8Lw"</span><span class="p">,</span>
<span class="s2">"m"</span><span class="o">:</span> <span class="s2">"3234"</span>
<span class="p">},</span>
<span class="s2">"form"</span><span class="o">:</span> <span class="p">{},</span>
<span class="s2">"headers"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"Accept"</span><span class="o">:</span> <span class="s2">"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"</span><span class="p">,</span>
<span class="s2">"Accept-Charset"</span><span class="o">:</span> <span class="s2">"ISO-8859-1,utf-8;q=0.7,*;q=0.3"</span><span class="p">,</span>
<span class="s2">"Accept-Encoding"</span><span class="o">:</span> <span class="s2">"gzip,deflate,sdch"</span><span class="p">,</span>
<span class="s2">"Accept-Language"</span><span class="o">:</span> <span class="s2">"en-US,en;q=0.8"</span><span class="p">,</span>
<span class="s2">"Connection"</span><span class="o">:</span> <span class="s2">"keep-alive"</span><span class="p">,</span>
<span class="s2">"Cookie"</span><span class="o">:</span> <span class="s2">"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"</span><span class="p">,</span>
<span class="s2">"Host"</span><span class="o">:</span> <span class="s2">"127.0.0.1:5984"</span><span class="p">,</span>
<span class="s2">"User-Agent"</span><span class="o">:</span> <span class="s2">"Mozilla/5.0 (Windows NT 5.2) AppleWebKit/535.7 (KHTML, like Gecko) Chrome/16.0.912.75 Safari/535.7"</span>
<span class="p">},</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"foo"</span><span class="p">,</span>
<span class="s2">"info"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"committed_update_seq"</span><span class="o">:</span> <span class="mi">2701412</span><span class="p">,</span>
<span class="s2">"compact_running"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
<span class="s2">"data_size"</span><span class="o">:</span> <span class="mi">7580843252</span><span class="p">,</span>
<span class="s2">"db_name"</span><span class="o">:</span> <span class="s2">"mailbox"</span><span class="p">,</span>
<span class="s2">"disk_format_version"</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span>
<span class="s2">"disk_size"</span><span class="o">:</span> <span class="mi">14325313673</span><span class="p">,</span>
<span class="s2">"doc_count"</span><span class="o">:</span> <span class="mi">2262757</span><span class="p">,</span>
<span class="s2">"doc_del_count"</span><span class="o">:</span> <span class="mi">560</span><span class="p">,</span>
<span class="s2">"instance_start_time"</span><span class="o">:</span> <span class="s2">"1347601025628957"</span><span class="p">,</span>
<span class="s2">"purge_seq"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"update_seq"</span><span class="o">:</span> <span class="mi">2701412</span>
<span class="p">},</span>
<span class="s2">"method"</span><span class="o">:</span> <span class="s2">"GET"</span><span class="p">,</span>
<span class="s2">"path"</span><span class="o">:</span> <span class="p">[</span>
<span class="s2">"mailbox"</span><span class="p">,</span>
<span class="s2">"_design"</span><span class="p">,</span>
<span class="s2">"request"</span><span class="p">,</span>
<span class="s2">"_show"</span><span class="p">,</span>
<span class="s2">"dump"</span><span class="p">,</span>
<span class="s2">"foo"</span>
<span class="p">],</span>
<span class="s2">"peer"</span><span class="o">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span>
<span class="s2">"query"</span><span class="o">:</span> <span class="p">{},</span>
<span class="s2">"raw_path"</span><span class="o">:</span> <span class="s2">"/mailbox/_design/request/_show/dump/foo"</span><span class="p">,</span>
<span class="s2">"requested_path"</span><span class="o">:</span> <span class="p">[</span>
<span class="s2">"mailbox"</span><span class="p">,</span>
<span class="s2">"_design"</span><span class="p">,</span>
<span class="s2">"request"</span><span class="p">,</span>
<span class="s2">"_show"</span><span class="p">,</span>
<span class="s2">"dump"</span><span class="p">,</span>
<span class="s2">"foo"</span>
<span class="p">],</span>
<span class="s2">"secObj"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"admins"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"names"</span><span class="o">:</span> <span class="p">[</span>
<span class="s2">"Bob"</span>
<span class="p">],</span>
<span class="s2">"roles"</span><span class="o">:</span> <span class="p">[]</span>
<span class="p">},</span>
<span class="s2">"members"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"names"</span><span class="o">:</span> <span class="p">[</span>
<span class="s2">"Mike"</span><span class="p">,</span>
<span class="s2">"Alice"</span>
<span class="p">],</span>
<span class="s2">"roles"</span><span class="o">:</span> <span class="p">[]</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"userCtx"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"db"</span><span class="o">:</span> <span class="s2">"mailbox"</span><span class="p">,</span>
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Mike"</span><span class="p">,</span>
<span class="s2">"roles"</span><span class="o">:</span> <span class="p">[</span>
<span class="s2">"user"</span>
<span class="p">]</span>
<span class="p">},</span>
<span class="s2">"uuid"</span><span class="o">:</span> <span class="s2">"3184f9d1ea934e1f81a24c71bde5c168"</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="response-object">
<span id="id4"></span><h2>11.15. Response object<a class="headerlink" href="#response-object" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>code</td>
<td>HTTP status code <cite>number</cite>.</td>
</tr>
<tr class="row-odd"><td>json</td>
<td>JSON encodable <cite>object</cite>.
Implicitly sets <cite>Content-Type</cite> header as
<tt class="docutils literal"><span class="pre">application/json</span></tt>.</td>
</tr>
<tr class="row-even"><td>body</td>
<td>Raw response text <cite>string</cite>.
Implicitly sets <cite>Content-Type</cite> header as
<tt class="docutils literal"><span class="pre">text/html;</span> <span class="pre">charset=utf-8</span></tt>.</td>
</tr>
<tr class="row-odd"><td>base64</td>
<td>Base64 encoded <cite>string</cite>.
Implicitly sets <cite>Content-Type</cite> header as
<tt class="docutils literal"><span class="pre">application/binary</span></tt>.</td>
</tr>
<tr class="row-even"><td>headers</td>
<td>Response headers <cite>object</cite>.
<cite>Content-Type</cite> header from this object
overrides any implicitly assigned one.</td>
</tr>
<tr class="row-odd"><td>stop</td>
<td><cite>boolean</cite> signal to stop iteration over
view result rows (for list functions only)</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last"><tt class="docutils literal"><span class="pre">body</span></tt>, <tt class="docutils literal"><span class="pre">base64</span></tt> and <tt class="docutils literal"><span class="pre">json</span></tt> object keys are overlaps each other and
the last wins. Since most realizations of key-value objects doesn’t preserve
key order mixing them may create confusing situation. Try to use only one of
them.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Any custom property makes CouchDB raise internal exception.
Also <cite>Response object</cite> could be a simple string value which would be
implicitly wrapped into <tt class="docutils literal"><span class="pre">{"body":</span> <span class="pre">...}</span></tt> object.</p>
</div>
</div>
<div class="section" id="returned-couchdb-document-with-detailed-revision-info">
<h2>11.16. Returned CouchDB Document with Detailed Revision Info<a class="headerlink" href="#returned-couchdb-document-with-detailed-revision-info" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>_id (optional)</td>
<td>Document ID</td>
</tr>
<tr class="row-odd"><td>_rev (optional)</td>
<td>Revision ID (when updating an existing
document)</td>
</tr>
<tr class="row-even"><td>_revs_info [array]</td>
<td>CouchDB Document Extended Revision Info</td>
</tr>
<tr class="row-odd"><td>rev</td>
<td>Full revision string</td>
</tr>
<tr class="row-even"><td>status</td>
<td>Status of the revision</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="returned-couchdb-document-with-revision-info">
<h2>11.17. Returned CouchDB Document with Revision Info<a class="headerlink" href="#returned-couchdb-document-with-revision-info" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>_id (optional)</td>
<td>Document ID</td>
</tr>
<tr class="row-odd"><td>_rev (optional)</td>
<td>Revision ID (when updating an existing
document)</td>
</tr>
<tr class="row-even"><td>_revisions</td>
<td>CouchDB Document Revisions</td>
</tr>
<tr class="row-odd"><td>ids [array]</td>
<td>Array of valid revision IDs, in reverse
order (latest first)</td>
</tr>
<tr class="row-even"><td>start</td>
<td>Prefix number for the latest revision</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="returned-document-with-attachments">
<h2>11.18. Returned Document with Attachments<a class="headerlink" href="#returned-document-with-attachments" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>_id (optional)</td>
<td>Document ID</td>
</tr>
<tr class="row-odd"><td>_rev (optional)</td>
<td>Revision ID (when updating an existing
document)</td>
</tr>
<tr class="row-even"><td>_attachments (optional)</td>
<td>Document Attachment</td>
</tr>
<tr class="row-odd"><td>filename</td>
<td>Attachment</td>
</tr>
<tr class="row-even"><td>stub</td>
<td>Indicates whether the attachment is a stub</td>
</tr>
<tr class="row-odd"><td>content_type</td>
<td>MIME Content type string</td>
</tr>
<tr class="row-even"><td>length</td>
<td>Length (bytes) of the attachment data</td>
</tr>
<tr class="row-odd"><td>revpos</td>
<td>Revision where this attachment exists</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="security-object">
<span id="id5"></span><h2>11.19. Security Object<a class="headerlink" href="#security-object" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>admins</td>
<td>Roles/Users with admin privileges</td>
</tr>
<tr class="row-odd"><td>roles [array]</td>
<td>List of roles with parent privilege</td>
</tr>
<tr class="row-even"><td>users [array]</td>
<td>List of users with parent privilege</td>
</tr>
<tr class="row-odd"><td>readers</td>
<td>Roles/Users with reader privileges</td>
</tr>
<tr class="row-even"><td>roles [array]</td>
<td>List of roles with parent privilege</td>
</tr>
<tr class="row-odd"><td>users [array]</td>
<td>List of users with parent privilege</td>
</tr>
</tbody>
</table>
<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"admins"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"names"</span><span class="o">:</span> <span class="p">[</span>
<span class="s2">"Bob"</span>
<span class="p">],</span>
<span class="s2">"roles"</span><span class="o">:</span> <span class="p">[]</span>
<span class="p">},</span>
<span class="s2">"members"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"names"</span><span class="o">:</span> <span class="p">[</span>
<span class="s2">"Mike"</span><span class="p">,</span>
<span class="s2">"Alice"</span>
<span class="p">],</span>
<span class="s2">"roles"</span><span class="o">:</span> <span class="p">[]</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="user-context-object">
<span id="userctx-object"></span><h2>11.20. User Context Object<a class="headerlink" href="#user-context-object" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>db</td>
<td>Database name in context of provided
operation.</td>
</tr>
<tr class="row-odd"><td>name</td>
<td>User name.</td>
</tr>
<tr class="row-even"><td>roles</td>
<td>List of user roles.</td>
</tr>
</tbody>
</table>
<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"db"</span><span class="o">:</span> <span class="s2">"mailbox"</span><span class="p">,</span>
<span class="s2">"name"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
<span class="s2">"roles"</span><span class="o">:</span> <span class="p">[</span>
<span class="s2">"_admin"</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="view-head-information">
<span id="view-head-info-object"></span><h2>11.21. View Head Information<a class="headerlink" href="#view-head-information" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>total_rows</td>
<td>Number of documents in the view</td>
</tr>
<tr class="row-odd"><td>offset</td>
<td>Offset where the document list started</td>
</tr>
</tbody>
</table>
<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"total_rows"</span><span class="o">:</span> <span class="mi">42</span><span class="p">,</span>
<span class="s2">"offset"</span><span class="o">:</span> <span class="mi">3</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a></p><!--
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
-->
<div id="searchbox" style="display: none">
<h3>Quick Search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q">
<input type="submit" value="Go">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<br>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">11. JSON Structure Reference</a><ul>
<li><a class="reference internal" href="#all-database-documents">11.1. All Database Documents</a></li>
<li><a class="reference internal" href="#bulk-document-response">11.2. Bulk Document Response</a></li>
<li><a class="reference internal" href="#bulk-documents">11.3. Bulk Documents</a></li>
<li><a class="reference internal" href="#changes-information-for-a-database">11.4. Changes information for a database</a></li>
<li><a class="reference internal" href="#couchdb-document">11.5. CouchDB Document</a></li>
<li><a class="reference internal" href="#couchdb-error-status">11.6. CouchDB Error Status</a></li>
<li><a class="reference internal" href="#couchdb-database-information-object">11.7. CouchDB database information object</a></li>
<li><a class="reference internal" href="#design-document">11.8. Design Document</a></li>
<li><a class="reference internal" href="#design-document-information">11.9. Design Document Information</a></li>
<li><a class="reference internal" href="#document-with-attachments">11.10. Document with Attachments</a></li>
<li><a class="reference internal" href="#list-of-active-tasks">11.11. List of Active Tasks</a></li>
<li><a class="reference internal" href="#replication-settings">11.12. Replication Settings</a></li>
<li><a class="reference internal" href="#replication-status">11.13. Replication Status</a></li>
<li><a class="reference internal" href="#request-object">11.14. Request object</a></li>
<li><a class="reference internal" href="#response-object">11.15. Response object</a></li>
<li><a class="reference internal" href="#returned-couchdb-document-with-detailed-revision-info">11.16. Returned CouchDB Document with Detailed Revision Info</a></li>
<li><a class="reference internal" href="#returned-couchdb-document-with-revision-info">11.17. Returned CouchDB Document with Revision Info</a></li>
<li><a class="reference internal" href="#returned-document-with-attachments">11.18. Returned Document with Attachments</a></li>
<li><a class="reference internal" href="#security-object">11.19. Security Object</a></li>
<li><a class="reference internal" href="#user-context-object">11.20. User Context Object</a></li>
<li><a class="reference internal" href="#view-head-information">11.21. View Head Information</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="api/local.html"
title="previous chapter">10.6. Local (non-replicating) Document Methods</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="experimental.html"
title="next chapter">12. Experimental Features</a></p><!--
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
-->
<h3>Utilities</h3>
<ul>
<li><a href="../">Futon</a></li>
</ul>
<!--
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
-->
<h3>More Help</h3>
<ul>
<li><a href="https://couchdb.apache.org/">Homepage</a></li>
<li><a href="http://wiki.apache.org/couchdb/">Wiki</a></li>
<li><a href="https://couchdb.apache.org/#mailing-list">Mailing Lists</a></li>
<li><a href="http://webchat.freenode.net/?channels=couchdb">IRC</a></li>
<li><a href="https://issues.apache.org/jira/browse/CouchDB">Issues</a></li>
<li><a href="download.html">Download</a></li>
<li><a href="https://github.com/apache/couchdb/blob/master/share/doc/src/json-structure.rst"
rel="nofollow">Show on GitHub</a></li>
<li><a href="https://github.com/apache/couchdb/edit/master/share/doc/src/json-structure.rst"
rel="nofollow">Edit on GitHub</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="http-api.html" title="HTTP API Reference"
>API Reference</a></li>
<li class="right" >
<a href="config-ref.html" title="Configuration Reference"
>Config Reference</a> |</li>
<li class="right" >
<a href="experimental.html" title="12. Experimental Features"
>next</a> |</li>
<li class="right" >
<a href="api/local.html" title="10.6. Local (non-replicating) Document Methods"
>previous</a> |</li>
<li><a href="index.html">Apache CouchDB 1.5 Documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2014, The Apache Software Foundation.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.
</div>
</body>
</html>
|