Bulk Insert Attachments

  • BulkInsert is RavenDB's high-performance data insertion operation.
    Use its attachmentsFor interface to add attachments to documents with great speed.

  • In this page:

Usage flow

  • Create a bulkInsert instance.

  • Pass the Document ID to the instance's attachmentsFor method.

  • To add an attachment, call store.
    Pass it the attachment's name, content, and type (optional).
    The store function can be called repeatedly as necessary.

  • Note:
    If an attachment with the specified name already exists on the document,
    the bulk insert operation will overwrite it.

Usage example

In this example, we attach a file to all User documents that match a query.

// Open a session
const session = documentStore.openSession();

// Choose user profiles for which to attach a file
const users = await session.query({ collection: "users" })
    .whereLessThan("age", 30)

// Prepare content that will be attached
const text = "Some contents here";
const byteArray = Buffer.from(text);

// Create a bulkInsert instance
const bulkInsert = documentStore.bulkInsert();

try {
    for (let i = 0; i < users.length; i++) {

        // Call `attachmentsFor`, pass the document ID for which to attach the file
        const attachmentsBulkInsert = bulkInsert.attachmentsFor(users[i].id);
        // Call 'store' to attach the byte array to the bulkInsert instance
        // The data stored in bulkInsert will be streamed to the server in batches 
        await attachmentsBulkInsert.store("attachmentName", byteArray);
} finally {
    // Call finish to send all remaining data to the server
    await bulkInsert.finish();
class User {
        id = null,
        age = 0,
        name = ''
    ) {
        Object.assign(this, {


Parameter Type Description
id string The document ID to which the attachment should be added.

store(name, bytes);
store(name, bytes, contentType);
Parameter Type Description
name string Name of attachment
bytes Buffer The attachment's content
contentType string Type of attachment (default: null)