Skip to content

Commit

Permalink
[FAB-10571] Documentation for CouchDB field names
Browse files Browse the repository at this point in the history
Ledger removed the "data" wrapper when using CouchDB as the
state database.  This change means that documents in the state
database must meet CouchDB's restrictions for top level field
names.

The documentation is being updated to clarify that the following
field names cannot be used at the top level:

- Any field beginning with an underscore, "_"
- ~version

Change-Id: Ie2db9590e6eae81bca07974c720ea97493486366
Signed-off-by: Chris Elder <chris.elder@us.ibm.com>
  • Loading branch information
Chris Elder committed Jun 10, 2018
1 parent af6974e commit 8b87d88
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions docs/source/couchdb_as_state_database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ 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``
- ``Any field beginning with an underscore, "_"``
- ``~version``

Using CouchDB from Chaincode
Expand Down

0 comments on commit 8b87d88

Please sign in to comment.