Skip to main content

Home > git-documentdb > Collection > update

Collection.update() method#

Update a JSON document

Signature:
update(jsonDoc: JsonDoc, options?: PutOptions): Promise<PutResultJsonDoc>;

Parameters#

ParameterTypeDescription
jsonDocJsonDocJsonDoc whose _id is shortId. shortId is a file path whose collectionPath and extension are omitted.
optionsPutOptions
Returns:

Promise<PutResultJsonDoc >

Remarks#

  • Throws DocumentNotFoundError if a specified document does not exist. It might be better to use put() instead of update().

  • The saved file path is ${GitDocumentDB#workingDir}/${Collection#collectionPath}/${jsonDoc._id}${extension} .

  • If _id is undefined, it is automatically generated.

  • An update operation is not skipped even if no change occurred on a specified document.

Exceptions#

Err.InvalidJsonObjectError

Err.DatabaseClosingError

Err.TaskCancelError

# Errors from validateDocument, validateId

# Errors from putWorker