Skip to main content

Home > git-documentdb > GitDocumentDB > update

GitDocumentDB.update() method#

Update a JSON document

Signature:
update(_id: string | undefined | null, jsonDoc: JsonDoc, options?: PutOptions): Promise<PutResultJsonDoc>;

Parameters#

ParameterTypeDescription
_idstring | undefined | null_id is a file path whose extension is omitted.
jsonDocJsonDoc
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}/${_id}extension on the file system.

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

  • This is an alias of GitDocumentDB#rootCollection.update()

Exceptions#

Err.InvalidJsonObjectError

Err.DatabaseClosingError

Err.TaskCancelError

# Errors from validateDocument, validateId

# Errors from putWorker