Adds a number of items to a collection.
The bulkInsert()
function returns a Promise that resolves after the items
have been added to the specified collection.
The Promise is rejected if the current user does not have "create" permissions
for the collection. Items are skipped if they include an _id
property whose
value matches an existing ID in the collection. Meaning, bulkInsert()
cannot
overwrite an existing item in the collection.
Calling the bulkInsert()
function triggers the beforeInsert()
and afterInsert()
hooks for each item
that is inserted if the hooks have been defined.
Use the options
parameter to run bulkInsert()
from backend code without
checking for permissions or without its registered hooks.
When inserting items into a collection that has a reference field, set
the values of the reference fields to the referenced item's _id
value or
the entire referenced item object.
The bulkInsert()
function adds the following properties and values to the item
when it adds it to the collection:
_id
: A unique identifier for an item in a collection, if the item doesn't have one or has one that is undefined
. You can optionally provide your own ID. Once an ID is assigned to an item it cannot be changed._createdDate
: The date the item was added to the collection._updatedDate
: The date the item was modified. When the item is first added, the createdDate
and updatedDate
are the same.Any valid JavaScript object can be added as a property value. The bulkInsert()
function maintains the structure of the specified object. For example,
objects that contain nested objects, Arrays, or Arrays with nested objects
are all added to the collection as defined.
The maximum size of an item that you can add to a collection is 500kb.
Notes:
_id
property value is set to null
or an empty string, an error is thrown.bulkInsert()
function is not supported for Single Item Collections.bulkInsert()
function does not support multi-reference fields. For multi-reference fields, use insertReference()
.bulkInsert()
will fail and issue an error.
The ID of the collection to add the item to.
The array must contain at least one item. Passing an empty array returns an error.
To find your collectionId, select the Databases tab in the Velo Sidebar. Hover over your collection, click the three dots, and select Edit Settings.
The items to add.
An object containing options to use when processing this operation.