Skip to content
This repository was archived by the owner on Oct 17, 2022. It is now read-only.

Commit 6ec827e

Browse files
jiahuili430nickva
authored andcommitted
Add GET _dbs_info
1 parent e35b506 commit 6ec827e

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

src/api/server/common.rst

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,76 @@
225225
``/_dbs_info``
226226
==============
227227

228+
.. versionadded:: 3.2
229+
230+
.. http:get:: /_dbs_info
231+
:synopsis: Returns all databases information
232+
233+
Returns a list of all the databases information in the CouchDB instance.
234+
235+
:<header Accept: - :mimetype:`application/json`
236+
- :mimetype:`text/plain`
237+
:query boolean descending: Return databases information in descending order
238+
by key. Default is ``false``.
239+
:query json endkey: Stop returning databases information when the specified
240+
key is reached.
241+
:query json end_key: Alias for ``endkey`` param
242+
:query number limit: Limit the number of the returned databases information
243+
to the specified number.
244+
:query number skip: Skip this number of databases before starting to return
245+
the results. Default is ``0``.
246+
:query json startkey: Return databases information starting with the
247+
specified key.
248+
:query json start_key: Alias for ``startkey``.
249+
:>header Content-Type: - :mimetype:`application/json`
250+
- :mimetype:`text/plain; charset=utf-8`
251+
:code 200: Request completed successfully
252+
253+
**Request**:
254+
255+
.. code-block:: http
256+
257+
GET /_dbs_info HTTP/1.1
258+
Accept: application/json
259+
Host: localhost:5984
260+
261+
**Response**:
262+
263+
.. code-block:: http
264+
265+
HTTP/1.1 200 OK
266+
Cache-Control: must-revalidate
267+
Content-Type: application/json
268+
Date: Thu, 18 Nov 2021 14:37:35 GMT
269+
Server: CouchDB (Erlang OTP/23)
270+
271+
[
272+
{
273+
"key": "animals",
274+
"info": {
275+
"db_name": "animals",
276+
"update_seq": "52232",
277+
"sizes": {
278+
"file": 1178613587,
279+
"external": 1713103872,
280+
"active": 1162451555
281+
},
282+
"purge_seq": 0,
283+
"doc_del_count": 0,
284+
"doc_count": 52224,
285+
"disk_format_version": 6,
286+
"compact_running": false,
287+
"cluster": {
288+
"q": 8,
289+
"n": 3,
290+
"w": 2,
291+
"r": 2
292+
},
293+
"instance_start_time": "0"
294+
}
295+
}
296+
]
297+
228298
.. versionadded:: 2.2
229299

230300
.. http:post:: /_dbs_info

0 commit comments

Comments
 (0)