From 5533049ded66c24e752cfb8f33d72441c03ed72c Mon Sep 17 00:00:00 2001 From: Yuta Namiki Date: Fri, 9 Mar 2018 16:42:50 +0900 Subject: [PATCH] [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 --- docs/source/couchdb_as_state_database.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/source/couchdb_as_state_database.rst b/docs/source/couchdb_as_state_database.rst index 66f4d2c6a16..9e138860dbf 100644 --- a/docs/source/couchdb_as_state_database.rst +++ b/docs/source/couchdb_as_state_database.rst @@ -37,6 +37,14 @@ default embedded LevelDB, and move to CouchDB if you require the additional comp It is a good practice to model chaincode asset data as JSON, so that you have the option to perform complex rich queries if needed in the future. +.. note:: A JSON document cannot use the following field names at the top level. + These are reserved for internal use. + + - ``_deleted`` + - ``_id`` + - ``_rev`` + - ``~version`` + Using CouchDB from Chaincode ----------------------------