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

Commit afcb3a2

Browse files
flimzynickva
authored andcommitted
Update description of GET /{db}/ response fields
1 parent 733a0ef commit afcb3a2

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

src/api/database/common.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,22 +55,26 @@
5555
- :mimetype:`text/plain`
5656
:>header Content-Type: - :mimetype:`application/json`
5757
- :mimetype:`text/plain; charset=utf-8`
58-
:>json number committed_update_seq: The number of committed update.
5958
:>json boolean compact_running: Set to ``true`` if the database compaction
6059
routine is operating on this database.
6160
:>json string db_name: The name of the database.
6261
:>json number disk_format_version: The version of the physical format used
6362
for the data when it is stored on disk.
64-
:>json number data_size: The number of bytes of live data inside
65-
the database file.
66-
:>json number disk_size: The length of the database file on disk.
67-
Views indexes are not included in the calculation.
63+
:>json number data_size: *Deprecated.* Use ``sizes.active`` instead.
64+
:>json number disk_size: *Deprecated.* Use ``sizes.file`` instead.
6865
:>json number doc_count: A count of the documents in the specified
6966
database.
7067
:>json number doc_del_count: Number of deleted documents
71-
:>json string instance_start_time: Timestamp of when the database was
72-
opened, expressed in microseconds since the epoch.
68+
:>json string instance_start_time: Always ``"0"``. (Returned for legacy
69+
reasons.)
70+
:>json object other: Used by Cloudant. *Deprecated.*
7371
:>json number purge_seq: The number of purge operations on the database.
72+
:>json number sizes.active: The size of live data inside the database, in
73+
bytes.
74+
:>json number sizes.external: The uncompressed size of database contents
75+
in bytes.
76+
:>json number sizes.file: The size of the database file on disk in bytes.
77+
Views indexes are not included in the calculation.
7478
:>json number update_seq: The current number of updates to the database.
7579
:code 200: Request completed successfully
7680
:code 404: Requested database not found

0 commit comments

Comments
 (0)