Skip to content

Commit

Permalink
updated documentation for getStateByPartialCompositeKey, getStateByP…
Browse files Browse the repository at this point in the history
…artialCompositeKeyWithPagination and getPrivateDataByPartialCompositeKey
  • Loading branch information
Francesco Vlacancich authored and Francesco Vlacancich committed Aug 2, 2021
1 parent c982390 commit d98e77b
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions libraries/fabric-shim/lib/stub.js
Original file line number Diff line number Diff line change
Expand Up @@ -839,6 +839,10 @@ class ChaincodeStub {
*
* The query is re-executed during validation phase to ensure result set has not changed since transaction
* endorsement (phantom reads detected).
*
* This function should be used only for a partial composite key.
* For a full composite key, an iter with empty response would be returned.
*
* @async
* @param {string} objectType A string used as the prefix of the resulting key
* @param {string[]} attributes List of attribute values to concatenate into the partial composite key
Expand Down Expand Up @@ -874,7 +878,9 @@ class ChaincodeStub {
* code point). See related functions SplitCompositeKey and CreateCompositeKey.
* Call Close() on the returned StateQueryIteratorInterface object when done.
* This call is only supported in a read only transaction.
*
* This function should be used only for a partial composite key.
* For a full composite key, an iter with empty response would be returned.
*
* @param {string} objectType
* @param {string[]} attributes
* @param {int} pageSize
Expand Down Expand Up @@ -1070,7 +1076,9 @@ class ChaincodeStub {
* Call Close() on the returned StateQueryIteratorInterface object when done.
* The query is re-executed during validation phase to ensure result set
* has not changed since transaction endorsement (phantom reads detected).
*
* This function should be used only for a partial composite key.
* For a full composite key, an iter with empty response would be returned.
*
* @param {string} collection The collection name
* @param {string} objectType A string used as the prefix of the resulting key
* @param {string[]} attributes List of attribute values to concatenate into the partial composite key
Expand Down

0 comments on commit d98e77b

Please sign in to comment.