Home > git-documentdb > Collection > insert

Collection.insert() method

Insert a JSON document

Signature:

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

Parameters

Parameter	Type	Description
shortId	string | undefined | null	shortId is a file path whose collectionPath and extension are omitted.
jsonDoc	JsonDoc
options	PutOptions

Returns:

Promise<PutResultJsonDoc >

Remarks

• Throws SameIdExistsError when a document that has the same _id exists. It might be better to use put() instead of insert().

• 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 shortId parameter.

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.SameIdExistsError