Home > git-documentdb > Collection > update

Collection.update() method

Update a JSON document

Signature:

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

Parameters

Parameter	Type	Description
_id	string | undefined | null
jsonDoc	JsonDoc
options	PutOptions

Returns:

Promise<PutResultJsonDoc >

Remarks

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

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

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

Exceptions

Err.InvalidJsonObjectError

Err.DatabaseClosingError

Err.TaskCancelError

# Errors from validateDocument, validateId

• Err.InvalidIdCharacterError

• Err.InvalidIdLengthError

# Errors from putWorker

• Err.UndefinedDBError

• Err.CannotCreateDirectoryError

• Err.CannotWriteDataError

• Err.DocumentNotFoundError