Skip to content

Commit

Permalink
Update description of a database info reply (#168)
Browse files Browse the repository at this point in the history
This adds description of a new information block "cluster"
and updates description of update_seq.
  • Loading branch information
eiri committed Sep 29, 2017
1 parent 6f89e9f commit a9a4988
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions src/api/database/common.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,12 @@
- :mimetype:`text/plain`
:>header Content-Type: - :mimetype:`application/json`
- :mimetype:`text/plain; charset=utf-8`
:>json number cluster.n: Replicas. The number of copies of every document.
:>json number cluster.q: Shards. The number of range partitions.
:>json number cluster.r: Read quorum. The number of consistent copies
of a document that need to be read before a successful reply.
:>json number cluster.w: Write quorum. The number of copies of a document
that need to be written before a successful reply.
:>json boolean compact_running: Set to ``true`` if the database compaction
routine is operating on this database.
:>json string db_name: The name of the database.
Expand All @@ -75,7 +81,9 @@
in bytes.
:>json number sizes.file: The size of the database file on disk in bytes.
Views indexes are not included in the calculation.
:>json number update_seq: The current number of updates to the database.
:>json string update_seq: An opaque string that describes the state
of the database. Do not rely on this string for counting the number
of updates.
:code 200: Request completed successfully
:code 404: Requested database not found

Expand All @@ -99,7 +107,12 @@
Server: CouchDB (Erlang/OTP)
{
"committed_update_seq": 292786,
"cluster": {
"n": 3,
"q": 8,
"r": 2,
"w": 2
},
"compact_running": false,
"data_size": 65031503,
"db_name": "receipts",
Expand All @@ -108,8 +121,16 @@
"doc_count": 6146,
"doc_del_count": 64637,
"instance_start_time": "0",
"other": {
"data_size": 66982448
},
"purge_seq": 0,
"update_seq": 292786
"sizes": {
"active": 65031503,
"external": 66982448,
"file": 137433211
},
"update_seq": "292786-g1AAAAF..."
}
.. http:put:: /{db}
Expand Down

0 comments on commit a9a4988

Please sign in to comment.