/usr/share/couchdb/www/docs/http-api.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 | <!--
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>HTTP API 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" />
<script type="text/javascript">
DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
</script>
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="HTTP API Reference"
>API Reference</a></li>
<li class="right" >
<a href="config-ref.html" title="Configuration Reference"
>Config Reference</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">
<h1>HTTP API Reference</h1>
<table class="indextable modindextable" cellspacing="0" cellpadding="2">
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/"><td></td><td>
<strong>/</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#get--"><tt class="xref">GET /</tt></a></td><td>
<em>Returns the welcome message and version information</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_active_tasks"><td></td><td>
<strong>/_active_tasks</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#get--_active_tasks"><tt class="xref">GET /_active_tasks</tt></a></td><td>
<em>Obtains a list of the tasks running in the server</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_all_dbs"><td></td><td>
<strong>/_all_dbs</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#get--_all_dbs"><tt class="xref">GET /_all_dbs</tt></a></td><td>
<em>Returns a list of all the databases</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_config"><td></td><td>
<strong>/_config</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/configuration.html#get--_config"><tt class="xref">GET /_config</tt></a></td><td>
<em>Obtains a list of the entire server configuration</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_config/{section}"><td></td><td>
<strong>/_config/{section}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/configuration.html#get--_config-{section}"><tt class="xref">GET /_config/{section}</tt></a></td><td>
<em>Returns all the configuration values for the specified section</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_config/{section}/{key}"><td></td><td>
<strong>/_config/{section}/{key}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/configuration.html#get--_config-{section}-{key}"><tt class="xref">GET /_config/{section}/{key}</tt></a></td><td>
<em>Returns a specific section/configuration value</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/configuration.html#put--_config-{section}-{key}"><tt class="xref">PUT /_config/{section}/{key}</tt></a></td><td>
<em>Sets the specified configuration value</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/configuration.html#delete--_config-{section}-{key}"><tt class="xref">DELETE /_config/{section}/{key}</tt></a></td><td>
<em>Removes the current setting</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_db_updates"><td></td><td>
<strong>/_db_updates</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#get--_db_updates"><tt class="xref">GET /_db_updates</tt></a></td><td>
<em>Return the server changes of databases</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_log"><td></td><td>
<strong>/_log</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#get--_log"><tt class="xref">GET /_log</tt></a></td><td>
<em>Returns the server log file</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_replicate"><td></td><td>
<strong>/_replicate</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#post--_replicate"><tt class="xref">POST /_replicate</tt></a></td><td>
<em>Starts or cancels the replication</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_restart"><td></td><td>
<strong>/_restart</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#post--_restart"><tt class="xref">POST /_restart</tt></a></td><td>
<em>Restarts the server</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_session"><td></td><td>
<strong>/_session</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/authn.html#get--_session"><tt class="xref">GET /_session</tt></a></td><td>
<em>Returns Cookie-based login user information</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/authn.html#post--_session"><tt class="xref">POST /_session</tt></a></td><td>
<em>Authenticates user by Cookie-based user login</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/authn.html#delete--_session"><tt class="xref">DELETE /_session</tt></a></td><td>
<em>Logout Cookie-based user</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_stats"><td></td><td>
<strong>/_stats</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#get--_stats"><tt class="xref">GET /_stats</tt></a></td><td>
<em>Returns server statistics</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_utils"><td></td><td>
<strong>/_utils</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#get--_utils"><tt class="xref">GET /_utils</tt></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_utils/"><td></td><td>
<strong>/_utils/</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#get--_utils-"><tt class="xref">GET /_utils/</tt></a></td><td>
<em>CouchDB administration interface (Futon)</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/_uuids"><td></td><td>
<strong>/_uuids</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#get--_uuids"><tt class="xref">GET /_uuids</tt></a></td><td>
<em>Generates a list of UUIDs from the server</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/favicon.ico"><td></td><td>
<strong>/favicon.ico</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/server/common.html#get--favicon.ico"><tt class="xref">GET /favicon.ico</tt></a></td><td>
<em>Returns the site icon</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}"><td></td><td>
<strong>/{db}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/common.html#head--{db}"><tt class="xref">HEAD /{db}</tt></a></td><td>
<em>Checks the database existence</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/common.html#get--{db}"><tt class="xref">GET /{db}</tt></a></td><td>
<em>Returns the database information</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/common.html#post--{db}"><tt class="xref">POST /{db}</tt></a></td><td>
<em>Creates a new document with generic ID if he had not specified</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/common.html#put--{db}"><tt class="xref">PUT /{db}</tt></a></td><td>
<em>Creates a new database</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/common.html#delete--{db}"><tt class="xref">DELETE /{db}</tt></a></td><td>
<em>Deletes an existing database</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_all_docs"><td></td><td>
<strong>/{db}/_all_docs</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/bulk-api.html#get--{db}-_all_docs"><tt class="xref">GET /{db}/_all_docs</tt></a></td><td>
<em>Returns a built-in view of all documents in this database</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/bulk-api.html#post--{db}-_all_docs"><tt class="xref">POST /{db}/_all_docs</tt></a></td><td>
<em>Returns certain rows from the built-in view of all documents</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_bulk_docs"><td></td><td>
<strong>/{db}/_bulk_docs</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/bulk-api.html#post--{db}-_bulk_docs"><tt class="xref">POST /{db}/_bulk_docs</tt></a></td><td>
<em>Inserts or updates multiple documents in to the database in a single request</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_changes"><td></td><td>
<strong>/{db}/_changes</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/changes.html#get--{db}-_changes"><tt class="xref">GET /{db}/_changes</tt></a></td><td>
<em>Returns changes for the given database</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/changes.html#post--{db}-_changes"><tt class="xref">POST /{db}/_changes</tt></a></td><td>
<em>Returns changes for the given database for certain document IDs</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_compact"><td></td><td>
<strong>/{db}/_compact</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/compact.html#post--{db}-_compact"><tt class="xref">POST /{db}/_compact</tt></a></td><td>
<em>Starts a compaction for the database</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_compact/{ddoc}"><td></td><td>
<strong>/{db}/_compact/{ddoc}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/compact.html#post--{db}-_compact-{ddoc}"><tt class="xref">POST /{db}/_compact/{ddoc}</tt></a></td><td>
<em>Starts a compaction for all the views in the selected design document</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_design/{ddoc}"><td></td><td>
<strong>/{db}/_design/{ddoc}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/common.html#head--{db}-_design-{ddoc}"><tt class="xref">HEAD /{db}/_design/{ddoc}</tt></a></td><td>
<em>Returns bare information in the HTTP Headers for the design document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/common.html#get--{db}-_design-{ddoc}"><tt class="xref">GET /{db}/_design/{ddoc}</tt></a></td><td>
<em>Returns the design document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/common.html#put--{db}-_design-{ddoc}"><tt class="xref">PUT /{db}/_design/{ddoc}</tt></a></td><td>
<em>Creates a new design document, or new version of an existing one</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/common.html#delete--{db}-_design-{ddoc}"><tt class="xref">DELETE /{db}/_design/{ddoc}</tt></a></td><td>
<em>Deletes the design document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/common.html#copy--{db}-_design-{ddoc}"><tt class="xref">COPY /{db}/_design/{ddoc}</tt></a></td><td>
<em>Copies the design document</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_design/{ddoc}/_info"><td></td><td>
<strong>/{db}/_design/{ddoc}/_info</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/common.html#get--{db}-_design-{ddoc}-_info"><tt class="xref">GET /{db}/_design/{ddoc}/_info</tt></a></td><td>
<em>Returns view index information for the specified design document</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view}"><td></td><td>
<strong>/{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/render.html#get--{db}-_design-{ddoc}-_list-{func}-{other-ddoc}-{view}"><tt class="xref">GET /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view}</tt></a></td><td>
<em>Executes a list function against the view from other design document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/render.html#post--{db}-_design-{ddoc}-_list-{func}-{other-ddoc}-{view}"><tt class="xref">POST /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view}</tt></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_design/{ddoc}/_list/{func}/{view}"><td></td><td>
<strong>/{db}/_design/{ddoc}/_list/{func}/{view}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/render.html#get--{db}-_design-{ddoc}-_list-{func}-{view}"><tt class="xref">GET /{db}/_design/{ddoc}/_list/{func}/{view}</tt></a></td><td>
<em>Executes a list function against the view from the same design document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/render.html#post--{db}-_design-{ddoc}-_list-{func}-{view}"><tt class="xref">POST /{db}/_design/{ddoc}/_list/{func}/{view}</tt></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_design/{ddoc}/_rewrite/{path}"><td></td><td>
<strong>/{db}/_design/{ddoc}/_rewrite/{path}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/rewrites.html#any--{db}-_design-{ddoc}-_rewrite-{path}"><tt class="xref">ANY /{db}/_design/{ddoc}/_rewrite/{path}</tt></a></td><td>
<em>Rewrites HTTP request for the specified path by using stored routing rules</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_design/{ddoc}/_show/{func}"><td></td><td>
<strong>/{db}/_design/{ddoc}/_show/{func}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/render.html#get--{db}-_design-{ddoc}-_show-{func}"><tt class="xref">GET /{db}/_design/{ddoc}/_show/{func}</tt></a></td><td>
<em>Executes a show function against null document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/render.html#post--{db}-_design-{ddoc}-_show-{func}"><tt class="xref">POST /{db}/_design/{ddoc}/_show/{func}</tt></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_design/{ddoc}/_show/{func}/{docid}"><td></td><td>
<strong>/{db}/_design/{ddoc}/_show/{func}/{docid}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/render.html#get--{db}-_design-{ddoc}-_show-{func}-{docid}"><tt class="xref">GET /{db}/_design/{ddoc}/_show/{func}/{docid}</tt></a></td><td>
<em>Executes a show function against the specified document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/render.html#post--{db}-_design-{ddoc}-_show-{func}-{docid}"><tt class="xref">POST /{db}/_design/{ddoc}/_show/{func}/{docid}</tt></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_design/{ddoc}/_update/{func}"><td></td><td>
<strong>/{db}/_design/{ddoc}/_update/{func}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/render.html#post--{db}-_design-{ddoc}-_update-{func}"><tt class="xref">POST /{db}/_design/{ddoc}/_update/{func}</tt></a></td><td>
<em>Executes an update function</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_design/{ddoc}/_update/{func}/{docid}"><td></td><td>
<strong>/{db}/_design/{ddoc}/_update/{func}/{docid}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/render.html#put--{db}-_design-{ddoc}-_update-{func}-{docid}"><tt class="xref">PUT /{db}/_design/{ddoc}/_update/{func}/{docid}</tt></a></td><td>
<em>Executes an update function against the specified document</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_design/{ddoc}/_view/{view}"><td></td><td>
<strong>/{db}/_design/{ddoc}/_view/{view}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/views.html#get--{db}-_design-{ddoc}-_view-{view}"><tt class="xref">GET /{db}/_design/{ddoc}/_view/{view}</tt></a></td><td>
<em>Returns results for the specified stored view</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/views.html#post--{db}-_design-{ddoc}-_view-{view}"><tt class="xref">POST /{db}/_design/{ddoc}/_view/{view}</tt></a></td><td>
<em>Returns certain rows for the specified stored view</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_design/{ddoc}/{attname}"><td></td><td>
<strong>/{db}/_design/{ddoc}/{attname}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/common.html#head--{db}-_design-{ddoc}-{attname}"><tt class="xref">HEAD /{db}/_design/{ddoc}/{attname}</tt></a></td><td>
<em>Returns bare information in the HTTP Headers for the attachment</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/common.html#get--{db}-_design-{ddoc}-{attname}"><tt class="xref">GET /{db}/_design/{ddoc}/{attname}</tt></a></td><td>
<em>Gets the attachment of a design document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/common.html#put--{db}-_design-{ddoc}-{attname}"><tt class="xref">PUT /{db}/_design/{ddoc}/{attname}</tt></a></td><td>
<em>Adds an attachment of a design document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/ddoc/common.html#delete--{db}-_design-{ddoc}-{attname}"><tt class="xref">DELETE /{db}/_design/{ddoc}/{attname}</tt></a></td><td>
<em>Deletes an attachment of a design document</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_ensure_full_commit"><td></td><td>
<strong>/{db}/_ensure_full_commit</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/compact.html#post--{db}-_ensure_full_commit"><tt class="xref">POST /{db}/_ensure_full_commit</tt></a></td><td>
<em>Makes sure all uncommitted changes are written and synchronized to the disk</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_local/{docid}"><td></td><td>
<strong>/{db}/_local/{docid}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/local.html#get--{db}-_local-{docid}"><tt class="xref">GET /{db}/_local/{docid}</tt></a></td><td>
<em>Returns the latest revision of the non-replicated document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/local.html#put--{db}-_local-{docid}"><tt class="xref">PUT /{db}/_local/{docid}</tt></a></td><td>
<em>Inserts a new version of the non-replicated document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/local.html#delete--{db}-_local-{docid}"><tt class="xref">DELETE /{db}/_local/{docid}</tt></a></td><td>
<em>Deletes the non-replicated document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/local.html#copy--{db}-_local-{docid}"><tt class="xref">COPY /{db}/_local/{docid}</tt></a></td><td>
<em>Copies the non-replicated document</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_missing_revs"><td></td><td>
<strong>/{db}/_missing_revs</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/misc.html#post--{db}-_missing_revs"><tt class="xref">POST /{db}/_missing_revs</tt></a></td><td>
<em>By given list of document revisions, returns the document revisions that do not exist in the database</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_purge"><td></td><td>
<strong>/{db}/_purge</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/misc.html#post--{db}-_purge"><tt class="xref">POST /{db}/_purge</tt></a></td><td>
<em>Purges some historical documents entirely from database history</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_revs_diff"><td></td><td>
<strong>/{db}/_revs_diff</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/misc.html#post--{db}-_revs_diff"><tt class="xref">POST /{db}/_revs_diff</tt></a></td><td>
<em>By given list of document revisions, returns differences between the given revisions and ones that are in the database</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_revs_limit"><td></td><td>
<strong>/{db}/_revs_limit</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/misc.html#get--{db}-_revs_limit"><tt class="xref">GET /{db}/_revs_limit</tt></a></td><td>
<em>Returns the limit of historical revisions to store for a single document in the database</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/misc.html#put--{db}-_revs_limit"><tt class="xref">PUT /{db}/_revs_limit</tt></a></td><td>
<em>Sets the limit of historical revisions to store for a single document in the database</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_security"><td></td><td>
<strong>/{db}/_security</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/security.html#get--{db}-_security"><tt class="xref">GET /{db}/_security</tt></a></td><td>
<em>Returns the special security object for the database</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/security.html#put--{db}-_security"><tt class="xref">PUT /{db}/_security</tt></a></td><td>
<em>Sets the special security object for the database</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_temp_view"><td></td><td>
<strong>/{db}/_temp_view</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/temp-views.html#post--{db}-_temp_view"><tt class="xref">POST /{db}/_temp_view</tt></a></td><td>
<em>Executes a given view function for all documents and returns the result</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/_view_cleanup"><td></td><td>
<strong>/{db}/_view_cleanup</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/database/compact.html#post--{db}-_view_cleanup"><tt class="xref">POST /{db}/_view_cleanup</tt></a></td><td>
<em>Removes view files that are not used by any design document</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/{docid}"><td></td><td>
<strong>/{db}/{docid}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/document/common.html#head--{db}-{docid}"><tt class="xref">HEAD /{db}/{docid}</tt></a></td><td>
<em>Returns bare information in the HTTP Headers for the document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/document/common.html#get--{db}-{docid}"><tt class="xref">GET /{db}/{docid}</tt></a></td><td>
<em>Returns the document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/document/common.html#put--{db}-{docid}"><tt class="xref">PUT /{db}/{docid}</tt></a></td><td>
<em>Creates a new document, or new version of an existing document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/document/common.html#delete--{db}-{docid}"><tt class="xref">DELETE /{db}/{docid}</tt></a></td><td>
<em>Deletes the document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/document/common.html#copy--{db}-{docid}"><tt class="xref">COPY /{db}/{docid}</tt></a></td><td>
<em>Copies the document</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-/{db}/{docid}/{attname}"><td></td><td>
<strong>/{db}/{docid}/{attname}</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="api/document/attachments.html#head--{db}-{docid}-{attname}"><tt class="xref">HEAD /{db}/{docid}/{attname}</tt></a></td><td>
<em>Returns bare information in the HTTP Headers for the attachment</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/document/attachments.html#get--{db}-{docid}-{attname}"><tt class="xref">GET /{db}/{docid}/{attname}</tt></a></td><td>
<em>Gets the attachment of a document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/document/attachments.html#put--{db}-{docid}-{attname}"><tt class="xref">PUT /{db}/{docid}/{attname}</tt></a></td><td>
<em>Adds an attachment of a document</em></td></tr>
<tr>
<td></td>
<td>
<a href="api/document/attachments.html#delete--{db}-{docid}-{attname}"><tt class="xref">DELETE /{db}/{docid}/{attname}</tt></a></td><td>
<em>Deletes an attachment of a document</em></td></tr>
</table>
</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><!--
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>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="HTTP API Reference"
>API Reference</a></li>
<li class="right" >
<a href="config-ref.html" title="Configuration Reference"
>Config Reference</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>
|