Skip to main content

Home > git-documentdb > GitDocumentDB > put

GitDocumentDB.put() method#

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

Signature:
put(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#

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

  • If _id is undefined, it is automatically generated.

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

Exceptions#

Err.InvalidJsonObjectError

Err.DatabaseClosingError

Err.TaskCancelError

# Errors from validateDocument, validateId

# Errors from putWorker