Skip to content
This repository was archived by the owner on Oct 17, 2022. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions src/api/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,6 @@ listing the supported HTTP methods. For example:
"reason":"Only GET,HEAD allowed"
}

The CouchDB design document API and the functions when returning HTML (for
example as part of a show or list) enables you to include custom HTTP headers
through the ``headers`` block of the return object.

HTTP Headers
============

Expand Down
6 changes: 3 additions & 3 deletions src/api/ddoc/common.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@
to process design document functions
* **options** (*object*): View's default options
* **filters** (*object*): :ref:`Filter functions <filterfun>` definition
* **lists** (*object*): :ref:`List functions <listfun>` definition
* **rewrites** (*array* or *string*): Rewrite rules definition
* **shows** (*object*): :ref:`Show functions <showfun>` definition
* **lists** (*object*): :ref:`List functions <listfun>` definition. *Deprecated.*
* **rewrites** (*array* or *string*): Rewrite rules definition. *Deprecated.*
* **shows** (*object*): :ref:`Show functions <showfun>` definition. *Deprecated.*
* **updates** (*object*): :ref:`Update functions <updatefun>` definition
* **validate_doc_update** (*string*): :ref:`Validate document update
<vdufun>` function source
Expand Down
16 changes: 16 additions & 0 deletions src/api/ddoc/render.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
``/db/_design/design-doc/_show/show-name``
==========================================

.. warning::

Show functions are deprecated in CouchDB 3.0, and will be removed in CouchDB 4.0.

.. http:get:: /{db}/_design/{ddoc}/_show/{func}
:synopsis: Executes a show function against null document

Expand Down Expand Up @@ -76,6 +80,10 @@
``/db/_design/design-doc/_show/show-name/doc-id``
=================================================

.. warning::

Show functions are deprecated in CouchDB 3.0, and will be removed in CouchDB 4.0.

.. http:get:: /{db}/_design/{ddoc}/_show/{func}/{docid}
:synopsis: Executes a show function against the specified document

Expand Down Expand Up @@ -137,6 +145,10 @@
``/db/_design/design-doc/_list/list-name/view-name``
====================================================

.. warning::

List functions are deprecated in CouchDB 3.0, and will be removed in CouchDB 4.0.

.. http:get:: /{db}/_design/{ddoc}/_list/{func}/{view}
:synopsis: Executes a list function against the view from the same
design document
Expand Down Expand Up @@ -204,6 +216,10 @@
``/db/_design/design-doc/_list/list-name/other-ddoc/view-name``
===============================================================

.. warning::

List functions are deprecated in CouchDB 3.0, and will be removed in CouchDB 4.0.

.. http:get:: /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view}
:synopsis: Executes a list function against the view from other
design document
Expand Down
4 changes: 4 additions & 0 deletions src/api/ddoc/rewrites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
``/db/_design/design-doc/_rewrite/path``
========================================

.. warning::

Rewrites are deprecated in CouchDB 3.0, and will be removed in CouchDB 4.0.

.. http:any:: /{db}/_design/{ddoc}/_rewrite/{path}
:synopsis: Rewrites HTTP request for the specified path by using stored
array of routing rules or JavaScript function
Expand Down
8 changes: 8 additions & 0 deletions src/config/http.rst
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,10 @@ Cross-Origin Resource Sharing
Per Virtual Host Configuration
------------------------------

.. warning::

Virtual Hosts are deprecated in CouchDB 3.0, and will be removed in CouchDB 4.0.

To set the options for a :section:`vhosts`, you will need to create a section
with the vhost name prefixed by ``cors:``. Example case for the vhost
`example.com`::
Expand All @@ -549,6 +553,10 @@ or behaviour.
Virtual Hosts
=============

.. warning::

Virtual Hosts are deprecated in CouchDB 3.0, and will be removed in CouchDB 4.0.

.. config:section:: vhosts :: Virtual Hosts

CouchDB can map requests to different locations based on the ``Host``
Expand Down
8 changes: 8 additions & 0 deletions src/ddocs/ddocs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,10 @@ objects.
Show Functions
==============

.. warning::

Show functions are deprecated in CouchDB 3.0, and will be removed in CouchDB 4.0.

.. function:: showfun(doc, req)

:param doc: The document that is being processed; may be omitted.
Expand Down Expand Up @@ -450,6 +454,10 @@ correctly, and keys with invalid characters, but you've got the idea!
List Functions
==============

.. warning::

List functions are deprecated in CouchDB 3.0, and will be removed in CouchDB 4.0.

.. function:: listfun(head, req)

:param head: :ref:`view_head_info_object`
Expand Down
3 changes: 1 addition & 2 deletions src/intro/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -270,8 +270,7 @@ special security-related constraints applied. Below is a list of how the
(:get:`GET /_users/_all_docs </{db}/_all_docs>`)
- Only administrators may listen to :ref:`changes feed
<changes>` (:get:`GET /_users/_changes </{db}/_changes>`)
- Only administrators may execute design functions like :ref:`views <viewfun>`,
:ref:`shows <showfun>` and :ref:`others <ddocs>`
- Only administrators may execute design functions like :ref:`views <viewfun>`.
- There is a special design document ``_auth`` that cannot be modified
- Every document except the `design documents` represent registered
CouchDB users and belong to them
Expand Down
5 changes: 2 additions & 3 deletions src/query-server/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ Query Server
============

The `Query server` is an external process that communicates with CouchDB by JSON
protocol through stdio interface and processed all
:ref:`design functions <ddocs>` calls:
:ref:`views <viewfun>`, :ref:`shows <showfun>`, :ref:`lists <listfun>` and more.
protocol through stdio interface and processes all
:ref:`design functions <ddocs>` calls, such as JavaScript :ref:`views <viewfun>`.

The default query server is written in
:ref:`JavaScript <query-server/js>`, running via `Mozilla SpiderMonkey`_.
Expand Down
8 changes: 8 additions & 0 deletions src/query-server/protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,10 @@ second phase.
``shows``
---------

.. warning::

Show functions are deprecated in CouchDB 3.0, and will be removed in CouchDB 4.0.

:Command: ``ddoc``
:SubCommand: ``shows``
:Arguments:
Expand Down Expand Up @@ -421,6 +425,10 @@ The Query Server sends::
``lists``
---------

.. warning::

List functions are deprecated in CouchDB 3.0, and will be removed in CouchDB 4.0.

:Command: ``ddoc``
:SubCommand: ``lists``
:Arguments:
Expand Down
13 changes: 13 additions & 0 deletions src/whatsnew/3.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,19 @@ CouchDB 3.0:
default. A setting exists in the configuration file to revert this behaviour. The
ability to override the disable setting is expected to be removed in CouchDB 4.0.

Deprecated feature warnings
---------------------------

The following features are deprecated in CouchDB 3.0 and will be removed in CouchDB 4.0:

* Show functions (``/{db}/{ddoc}/_show``)

* List functions (``/{db}/{ddoc}/_list``)

* Virtual hosts and ini-file rewrites

* Rewrite functions (``/{db}/{ddoc}/_rewrite``)

.. _release/3.0.0:

Version 3.0.0
Expand Down