Home > git-documentdb > GitDocumentDB > update

GitDocumentDB.update() method

Update a JSON document

Signature:

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

Parameters

Parameter	Type	Description
jsonDoc	JsonDoc	JsonDoc whose _id is shortId. shortId is a file path whose collectionPath and extension are omitted.
options	PutOptions

Returns:

Promise<PutResultJsonDoc >

Remarks

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

• If _id is undefined, it is automatically generated.

• The saved file path is ${GitDocumentDB#workingDir}/${_id}extension on the file system.

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

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