Skip to main content

Home > git-documentdb > Collection > put

Collection.put() method#

Insert a JSON document if not exists. Otherwise, update it.

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

Parameters#

ParameterTypeDescription
shortIdstring | undefined | nullshortId is a file path whose collectionPath and extension are omitted.
jsonDocJsonDoc
optionsPutOptions
Returns:

Promise<PutResultJsonDoc >

Remarks#

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

  • If shortId is undefined, it is automatically generated.

  • _id property of a JsonDoc is automatically set or overwritten by a shortId parameter.

  • 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

Edit this page