Add batch operations

Author: vishnugt

src/lib/indexes.ts

@@ -317,6 +317,31 @@ class Index<T = Record<string, any>> {
     return await this.httpRequest.post(url, documents, options)
   }
 
+    /**
+   * Add or replace multiples documents to an index in batches
+   * @memberof Index
+   * @method addDocumentsInBatch
+   */
+    async addDocumentsInBatch(
+      documents: Array<Document<T>>,
+      batchSize: number = 1000,
+      options?: AddDocumentParams
+    ): Promise<EnqueuedUpdate[]> {
+      const resultArray = []
+      let batchDocuments = [];
+      for(let i = 0, n = documents.length; i < n; ++i) {
+        if(batchDocuments.length == batchSize) {
+          resultArray.push(await this.addDocuments(batchDocuments, options));
+          batchDocuments = []
+        }
+        batchDocuments.push(documents[i]);
+      }
+      if(batchDocuments.length != 0) {
+        resultArray.push(await this.addDocuments(batchDocuments, options));
+      }
+      return resultArray
+    }
+
   /**
    * Add or update multiples documents to an index
    * @memberof Index
@@ -330,6 +355,31 @@ class Index<T = Record<string, any>> {
     return await this.httpRequest.put(url, documents, options)
   }
 
+    /**
+   * Add or update multiples documents to an index in batches
+   * @memberof Index
+   * @method updateDocuments
+   */
+    async updateDocumentsInBatch(
+    documents: Array<Document<T>>,
+    batchSize: number = 1000,
+    options?: AddDocumentParams
+    ): Promise<EnqueuedUpdate[]> {
+      const resultArray = []
+      let batchDocuments = [];
+      for(let i = 0, n = documents.length; i < n; ++i) {
+        if(batchDocuments.length == batchSize) {
+          resultArray.push(await this.updateDocuments(batchDocuments, options));
+          batchDocuments = []
+        }
+        batchDocuments.push(documents[i]);
+      }
+      if(batchDocuments.length != 0) {
+        resultArray.push(await this.updateDocuments(batchDocuments, options));
+      }
+      return resultArray
+    }
+
   /**
    * Delete one document
    * @memberof Index

tests/documents_tests.ts

@@ -71,6 +71,24 @@ describe.each([
     await client.index(indexPk.uid).waitForPendingUpdate(updateId)
   })
 
+
+  test(`${permission} key: Add documents to uid with primary key in batch`, async () => {
+    const updateIds:number[] = await client
+      .index(indexPk.uid)
+      .addDocumentsInBatch(dataset, 4)
+      .then((response: EnqueuedUpdate[]) => {
+        expect(response).toBeInstanceOf(Array);
+        expect(response).toHaveLength(2);
+        expect(response[0]).toHaveProperty('updateId', expect.any(Number))
+        const tempIds:number[] = [];
+        response.forEach((entry) => tempIds.push(entry.updateId))
+        return tempIds
+      })
+    for(let updateId of updateIds) {
+      await client.index(indexPk.uid).waitForPendingUpdate(updateId)
+    }
+  })
+
   test(`${permission} key: Get documents with string attributesToRetrieve`, async () => {
     await client
       .index(indexNoPk.uid)