Add export method feature

.code-samples.meilisearch.yaml

@@ -858,3 +858,15 @@ search_parameter_reference_media_1: |-
       }
     }
   })
+export_post_1: |-
+  client.export({
+    url: 'http://localhost:7711',
+    apiKey: null,
+    payloadSize: '123 MiB',
+    indexes: {
+      '*': {
+        filter: null,
+        overrideSettings: true
+      }
+    }
+  })

.github/workflows/meilisearch-prototype-tests.yml

@@ -44,6 +44,13 @@ jobs:
           MEILI_NO_ANALYTICS: 'true'
         ports:
           - '7700:7700'
+      export-meilisearch:
+        image: getmeili/meilisearch:${{ needs.meilisearch-version.outputs.version }}
+        env:
+          MEILI_MASTER_KEY: 'masterKey'
+          MEILI_NO_ANALYTICS: 'true'
+        ports:
+          - '7702:7700'
     strategy:
       matrix:
         node: ['20', '22']

.github/workflows/pre-release-tests.yml

@@ -41,6 +41,13 @@ jobs:
           MEILI_NO_ANALYTICS: 'true'
         ports:
           - '7700:7700'
+      export-meilisearch:
+        image: getmeili/meilisearch:${{ needs.meilisearch-version.outputs.version }}
+        env:
+          MEILI_MASTER_KEY: 'masterKey'
+          MEILI_NO_ANALYTICS: 'true'
+        ports:
+          - '7702:7700'
     strategy:
       matrix:
         node: ['20', '22']

.github/workflows/tests.yml

@@ -33,6 +33,13 @@ jobs:
           MEILI_NO_ANALYTICS: 'true'
         ports:
           - '7700:7700'
+      export-meilisearch:
+        image: getmeili/meilisearch:latest
+        env:
+          MEILI_MASTER_KEY: 'masterKey'
+          MEILI_NO_ANALYTICS: 'true'
+        ports:
+          - '7702:7700'
     strategy:
       fail-fast: false
       matrix:

docker-compose.yml

@@ -20,3 +20,11 @@ services:
     environment:
       - MEILI_MASTER_KEY=masterKey
       - MEILI_NO_ANALYTICS=true
+
+  export-meilisearch:
+    image: getmeili/meilisearch
+    ports:
+      - "7702:7700"
+    environment:
+      - MEILI_MASTER_KEY=masterKey
+      - MEILI_NO_ANALYTICS=true

src/meilisearch.ts

@@ -34,6 +34,7 @@ import type {
   ResultsWrapper,
   WebhookCreatePayload,
   WebhookUpdatePayload,
+  ExportOptions,
 } from "./types/index.js";
 import { ErrorStatusCode } from "./types/index.js";
 import { HttpRequests } from "./http-requests.js";
@@ -547,6 +548,15 @@ export class MeiliSearch {
     });
   }
 
+  ///
+  /// EXPORT
+  ///
+
+  /** {@link https://www.meilisearch.com/docs/reference/api/export} */
+  export(options: ExportOptions): EnqueuedTaskPromise {
+    return this.#httpRequestsWithTask.post({ path: "export", body: options });
+  }
+
   ///
   /// EXPERIMENTAL-FEATURES
   ///

src/types/export.ts

@@ -0,0 +1,30 @@
+import type { Filter } from "./types.js";
+
+/**
+ * {@link https://www.meilisearch.com/docs/reference/api/export#indexes}
+ *
+ * @see `meilisearch::routes::export::ExportIndexSettings`
+ */
+export type ExportIndexSettings = {
+  filter?: Filter;
+  overrideSettings?: boolean;
+};
+
+/** {@link https://www.meilisearch.com/docs/reference/api/export#indexes} */
+export type ExportIndexSettingsRecord = Record<string, ExportIndexSettings>;
+
+/**
+ * {@link https://www.meilisearch.com/docs/reference/api/export#body}
+ *
+ * @see `meilisearch::routes::export::Export`
+ */
+export type ExportOptions = {
+  /** {@link https://www.meilisearch.com/docs/reference/api/export#url} */
+  url: string;
+  /** {@link https://www.meilisearch.com/docs/reference/api/export#apikey} */
+  apiKey?: string;
+  /** {@link https://www.meilisearch.com/docs/reference/api/export#payloadsize} */
+  payloadSize?: string;
+  /** {@link https://www.meilisearch.com/docs/reference/api/export#indexes} */
+  indexes?: ExportIndexSettingsRecord;
+};

src/types/index.ts

@@ -1,4 +1,5 @@
 export * from "./experimental-features.js";
+export * from "./export.js";
 export * from "./task_and_batch.js";
 export * from "./token.js";
 export * from "./types.js";

src/types/task_and_batch.ts

@@ -52,6 +52,7 @@ export type TaskType = PascalToCamelCase<
   | "TaskDeletion"
   | "DumpCreation"
   | "SnapshotCreation"
+  | "Export"
   | "UpgradeDatabase"
 >;
 

tests/export.test.ts

@@ -0,0 +1,38 @@
+import { randomUUID } from "node:crypto";
+import { afterAll, beforeAll, test } from "vitest";
+import { assert, getClient } from "./utils/meilisearch-test-utils.js";
+
+const INDEX_UID = randomUUID();
+const ms = await getClient("Master");
+
+beforeAll(async () => {
+  const task = await ms.createIndex(INDEX_UID).waitTask();
+  assert.isTaskSuccessful(task);
+
+  const task2 = await ms
+    .index(INDEX_UID)
+    .addDocuments([{ id: 0, beep: "boop" }])
+    .waitTask();
+  assert.isTaskSuccessful(task2);
+});
+
+afterAll(async () => {
+  const task = await ms.deleteIndex(INDEX_UID).waitTask();
+  assert.isTaskSuccessful(task);
+});
+
+test(`${ms.export.name} method`, async () => {
+  const task = await ms
+    .export({
+      url: "http://127.0.0.1:7702",
+      apiKey: "masterKey",
+      payloadSize: "50MiB",
+      indexes: {
+        [INDEX_UID]: { filter: "beep = boop", overrideSettings: true },
+      },
+    })
+    .waitTask({ timeout: 60_000 });
+
+  assert.isTaskSuccessful(task);
+  assert.strictEqual(task.type, "export");
+});

tests/utils/meilisearch-test-utils.ts

@@ -199,6 +199,7 @@ const source = {
         taskDeletion: null,
         dumpCreation: null,
         snapshotCreation: null,
+        export: null,
         upgradeDatabase: null,
       }),
     );

tests/utils/tasks-and-batches.ts

@@ -29,6 +29,7 @@ export const possibleTaskTypes = objectKeys<TaskType>({
   taskDeletion: null,
   dumpCreation: null,
   snapshotCreation: null,
+  export: null,
   upgradeDatabase: null,
 });