Skip to content

Commit

Permalink
Update comments for appendBlockFromStream and appendBlockFromText, un…
Browse files Browse the repository at this point in the history
…block the API usage in parallel
  • Loading branch information
XiaoningLiu committed Jun 26, 2018
1 parent 6915d68 commit c92e450
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions lib/services/blob/blobservice.core.js
Original file line number Diff line number Diff line change
Expand Up @@ -4024,8 +4024,10 @@ BlobService.prototype.appendFromText = function (container, blob, text, optionsO

/**
* Creates a new block from a read stream to be appended to an append blob.
* This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks.
* If the sequence of data to be appended is important, please use this API strictly in a single writer.
* If you are guaranteed to have a single writer scenario, please look at options.absorbConditionalErrorsOnRetry and see if setting this flag to true is acceptable for you.
* If the sequence of data to be appended is not important, this API can be used in parallel,
* in this case, options.appendPosition can be left without settings.
*
* @this {BlobService}
* @param {string} container The container name.
Expand Down Expand Up @@ -4078,8 +4080,10 @@ BlobService.prototype.appendBlockFromStream = function (container, blob, readStr

/**
* Creates a new block from a text to be appended to an append blob.
* This API should be used strictly in a single writer scenario because the API internally uses the append-offset conditional header to avoid duplicate blocks.
* If the sequence of data to be appended is important, please use this API strictly in a single writer.
* If you are guaranteed to have a single writer scenario, please look at options.absorbConditionalErrorsOnRetry and see if setting this flag to true is acceptable for you.
* If the sequence of data to be appended is not important, this API can be used in parallel,
* in this case, options.appendPosition can be left without settings.
*
* @this {BlobService}
* @param {string} container The container name.
Expand Down

0 comments on commit c92e450

Please sign in to comment.