Skip to content

Commit 0c2d6b7

Browse files
author
Yuta Namiki
committed
[FAB-8738] Document Reserved Field Names in CouchDB
This patch add description of reserved field names in a JSON document to be put a CouchDB state database. Change-Id: I679a9de8cd73f1c4dc8b3a104d8e2a5e6657362e Signed-off-by: Yuta Namiki <y-namiki@ak.jp.nec.com>
1 parent a409d1f commit 0c2d6b7

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/source/couchdb_as_state_database.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ default embedded LevelDB, and move to CouchDB if you require the additional comp
3737
It is a good practice to model chaincode asset data as JSON, so that you have the option to perform
3838
complex rich queries if needed in the future.
3939

40+
.. note:: A JSON document cannot use the following field names at the top level.
41+
These are reserved for internal use.
42+
43+
- ``_deleted``
44+
- ``_id``
45+
- ``_rev``
46+
- ``~version``
47+
4048
Using CouchDB from Chaincode
4149
----------------------------
4250

0 commit comments

Comments
 (0)