kourou 0.27.0 → 0.28.0

package/README.md

@@ -27,7 +27,7 @@ $ npm install -g kourou
 $ kourou COMMAND
 running command...
 $ kourou (-v|--version|version)
-kourou/0.27.0 darwin-arm64 node-v18.17.1
+kourou/0.28.0 darwin-arm64 node-v20.10.0
 $ kourou --help [COMMAND]
 USAGE
   $ kourou COMMAND
@@ -161,6 +161,7 @@ All other arguments and options will be passed as-is to the `sdk:query` method.
 * [`kourou instance:logs`](#kourou-instancelogs)
 * [`kourou instance:spawn`](#kourou-instancespawn)
 * [`kourou paas:deploy ENVIRONMENT APPLICATIONID IMAGE`](#kourou-paasdeploy-environment-applicationid-image)
+* [`kourou paas:elasticsearch:dump ENVIRONMENT APPLICATIONID DUMPDIRECTORY`](#kourou-paaselasticsearchdump-environment-applicationid-dumpdirectory)
 * [`kourou paas:init PROJECT`](#kourou-paasinit-project)
 * [`kourou paas:login`](#kourou-paaslogin)
 * [`kourou paas:logs ENVIRONMENT APPLICATION`](#kourou-paaslogs-environment-application)
@@ -211,7 +212,7 @@ EXAMPLE
   kourou api-key:check eyJhbG...QxfQrc
 ```
 
-_See code: [src/commands/api-key/check.ts](src/commands/api-key/check.ts)_
+_See code: [lib/commands/api-key/check.js](lib/commands/api-key/check.js)_
 
 ## `kourou api-key:create USER`
 
@@ -239,7 +240,7 @@ OPTIONS
   --username=username            [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/api-key/create.ts](src/commands/api-key/create.ts)_
+_See code: [lib/commands/api-key/create.js](lib/commands/api-key/create.js)_
 
 ## `kourou api-key:delete USER ID`
 
@@ -268,7 +269,7 @@ EXAMPLE
   kourou vault:delete sigfox-gateway 1k-BF3EBjsXdvA2PR8x
 ```
 
-_See code: [src/commands/api-key/delete.ts](src/commands/api-key/delete.ts)_
+_See code: [lib/commands/api-key/delete.js](lib/commands/api-key/delete.js)_
 
 ## `kourou api-key:search USER`
 
@@ -294,7 +295,7 @@ OPTIONS
   --username=username  [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/api-key/search.ts](src/commands/api-key/search.ts)_
+_See code: [lib/commands/api-key/search.js](lib/commands/api-key/search.js)_
 
 ## `kourou app:debug-proxy`
 
@@ -332,7 +333,7 @@ OPTIONS
   --username=username        [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/app/debug-proxy.ts](src/commands/app/debug-proxy.ts)_
+_See code: [lib/commands/app/debug-proxy.js](lib/commands/app/debug-proxy.js)_
 
 ## `kourou app:doctor`
 
@@ -355,7 +356,7 @@ OPTIONS
   --username=username            [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/app/doctor.ts](src/commands/app/doctor.ts)_
+_See code: [lib/commands/app/doctor.js](lib/commands/app/doctor.js)_
 
 ## `kourou app:scaffold DESTINATION`
 
@@ -373,7 +374,7 @@ OPTIONS
   --help           show CLI help
 ```
 
-_See code: [src/commands/app/scaffold.ts](src/commands/app/scaffold.ts)_
+_See code: [lib/commands/app/scaffold.js](lib/commands/app/scaffold.js)_
 
 ## `kourou app:start-services`
 
@@ -388,7 +389,7 @@ OPTIONS
   --help   show CLI help
 ```
 
-_See code: [src/commands/app/start-services.ts](src/commands/app/start-services.ts)_
+_See code: [lib/commands/app/start-services.js](lib/commands/app/start-services.js)_
 
 ## `kourou autocomplete [SHELL]`
 
@@ -438,7 +439,7 @@ OPTIONS
   --username=username  [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/collection/create.ts](src/commands/collection/create.ts)_
+_See code: [lib/commands/collection/create.js](lib/commands/collection/create.js)_
 
 ## `kourou collection:export INDEX COLLECTION`
 
@@ -519,7 +520,7 @@ EXAMPLES
   kourou collection:export nyc-open-data yellow-taxi --query '{ term: { city: "Saigon" } }'
 ```
 
-_See code: [src/commands/collection/export.ts](src/commands/collection/export.ts)_
+_See code: [lib/commands/collection/export.js](lib/commands/collection/export.js)_
 
 ## `kourou collection:import PATH`
 
@@ -548,7 +549,7 @@ OPTIONS
   --username=username      [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/collection/import.ts](src/commands/collection/import.ts)_
+_See code: [lib/commands/collection/import.js](lib/commands/collection/import.js)_
 
 ## `kourou collection:migrate SCRIPT PATH`
 
@@ -577,7 +578,7 @@ OPTIONS
   --username=username      [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/collection/migrate.ts](src/commands/collection/migrate.ts)_
+_See code: [lib/commands/collection/migrate.js](lib/commands/collection/migrate.js)_
 
 ## `kourou config:diff FIRST SECOND`
 
@@ -599,7 +600,7 @@ EXAMPLE
   kourou config:diff config/local/kuzzlerc config/production/kuzzlerc
 ```
 
-_See code: [src/commands/config/diff.ts](src/commands/config/diff.ts)_
+_See code: [lib/commands/config/diff.js](lib/commands/config/diff.js)_
 
 ## `kourou document:search INDEX COLLECTION [QUERY]`
 
@@ -637,7 +638,7 @@ EXAMPLES
   kourou document:search iot sensors --editor
 ```
 
-_See code: [src/commands/document/search.ts](src/commands/document/search.ts)_
+_See code: [lib/commands/document/search.js](lib/commands/document/search.js)_
 
 ## `kourou es:aliases:cat`
 
@@ -653,7 +654,7 @@ OPTIONS
   --help           show CLI help
 ```
 
-_See code: [src/commands/es/aliases/cat.ts](src/commands/es/aliases/cat.ts)_
+_See code: [lib/commands/es/aliases/cat.js](lib/commands/es/aliases/cat.js)_
 
 ## `kourou es:indices:cat`
 
@@ -669,7 +670,7 @@ OPTIONS
   --help           show CLI help
 ```
 
-_See code: [src/commands/es/indices/cat.ts](src/commands/es/indices/cat.ts)_
+_See code: [lib/commands/es/indices/cat.js](lib/commands/es/indices/cat.js)_
 
 ## `kourou es:indices:get INDEX ID`
 
@@ -688,7 +689,7 @@ OPTIONS
   --help           show CLI help
 ```
 
-_See code: [src/commands/es/indices/get.ts](src/commands/es/indices/get.ts)_
+_See code: [lib/commands/es/indices/get.js](lib/commands/es/indices/get.js)_
 
 ## `kourou es:indices:insert INDEX`
 
@@ -708,7 +709,7 @@ OPTIONS
   --id=id          Document ID
 ```
 
-_See code: [src/commands/es/indices/insert.ts](src/commands/es/indices/insert.ts)_
+_See code: [lib/commands/es/indices/insert.js](lib/commands/es/indices/insert.js)_
 
 ## `kourou es:migrate`
 
@@ -735,7 +736,7 @@ EXAMPLES
   kourou es:migrate --src ./my-backup --dest http://elasticsearch:9200 --reset --batch-size 2000 --no-interactive
 ```
 
-_See code: [src/commands/es/migrate.ts](src/commands/es/migrate.ts)_
+_See code: [lib/commands/es/migrate.js](lib/commands/es/migrate.js)_
 
 ## `kourou es:snapshot:create REPOSITORY NAME`
 
@@ -754,7 +755,7 @@ OPTIONS
   --help           show CLI help
 ```
 
-_See code: [src/commands/es/snapshot/create.ts](src/commands/es/snapshot/create.ts)_
+_See code: [lib/commands/es/snapshot/create.js](lib/commands/es/snapshot/create.js)_
 
 ## `kourou es:snapshot:create-repository REPOSITORY LOCATION`
 
@@ -774,7 +775,7 @@ OPTIONS
   --help           show CLI help
 ```
 
-_See code: [src/commands/es/snapshot/create-repository.ts](src/commands/es/snapshot/create-repository.ts)_
+_See code: [lib/commands/es/snapshot/create-repository.js](lib/commands/es/snapshot/create-repository.js)_
 
 ## `kourou es:snapshot:list REPOSITORY`
 
@@ -792,7 +793,7 @@ OPTIONS
   --help           show CLI help
 ```
 
-_See code: [src/commands/es/snapshot/list.ts](src/commands/es/snapshot/list.ts)_
+_See code: [lib/commands/es/snapshot/list.js](lib/commands/es/snapshot/list.js)_
 
 ## `kourou file:decrypt FILE`
 
@@ -815,7 +816,7 @@ EXAMPLES
   kourou file:decrypt books/cryptonomicon.txt.enc -o books/cryptonomicon.txt --vault-key <vault-key>
 ```
 
-_See code: [src/commands/file/decrypt.ts](src/commands/file/decrypt.ts)_
+_See code: [lib/commands/file/decrypt.js](lib/commands/file/decrypt.js)_
 
 ## `kourou file:encrypt FILE`
 
@@ -838,7 +839,7 @@ EXAMPLES
   kourou file:encrypt books/cryptonomicon.txt -o books/cryptonomicon.txt.enc --vault-key <vault-key>
 ```
 
-_See code: [src/commands/file/encrypt.ts](src/commands/file/encrypt.ts)_
+_See code: [lib/commands/file/encrypt.js](lib/commands/file/encrypt.js)_
 
 ## `kourou file:test FILE`
 
@@ -858,7 +859,7 @@ EXAMPLE
   kourou file:test books/cryptonomicon.txt.enc --vault-key <vault-key>
 ```
 
-_See code: [src/commands/file/test.ts](src/commands/file/test.ts)_
+_See code: [lib/commands/file/test.js](lib/commands/file/test.js)_
 
 ## `kourou help [COMMAND]`
 
@@ -902,7 +903,7 @@ OPTIONS
   --username=username      [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/import.ts](src/commands/import.ts)_
+_See code: [lib/commands/import.js](lib/commands/import.js)_
 
 ## `kourou index:export INDEX`
 
@@ -952,7 +953,7 @@ EXAMPLES
   kourou index:export nyc-open-data --query '{"range":{"_kuzzle_info.createdAt":{"gt":1632935638866}}}'
 ```
 
-_See code: [src/commands/index/export.ts](src/commands/index/export.ts)_
+_See code: [lib/commands/index/export.js](lib/commands/index/export.js)_
 
 ## `kourou index:import PATH`
 
@@ -984,7 +985,7 @@ EXAMPLES
   kourou index:import ./dump/iot-data --index iot-data-production --no-mappings
 ```
 
-_See code: [src/commands/index/import.ts](src/commands/index/import.ts)_
+_See code: [lib/commands/index/import.js](lib/commands/index/import.js)_
 
 ## `kourou instance:kill`
 
@@ -999,7 +1000,7 @@ OPTIONS
   -i, --instance=instance  Kuzzle instance name [ex: stack-0]
 ```
 
-_See code: [src/commands/instance/kill.ts](src/commands/instance/kill.ts)_
+_See code: [lib/commands/instance/kill.js](lib/commands/instance/kill.js)_
 
 ## `kourou instance:list`
 
@@ -1010,7 +1011,7 @@ USAGE
   $ kourou instance:list
 ```
 
-_See code: [src/commands/instance/list.ts](src/commands/instance/list.ts)_
+_See code: [lib/commands/instance/list.js](lib/commands/instance/list.js)_
 
 ## `kourou instance:logs`
 
@@ -1025,7 +1026,7 @@ OPTIONS
   -i, --instance=instance  Kuzzle instance name
 ```
 
-_See code: [src/commands/instance/logs.ts](src/commands/instance/logs.ts)_
+_See code: [lib/commands/instance/logs.js](lib/commands/instance/logs.js)_
 
 ## `kourou instance:spawn`
 
@@ -1041,7 +1042,7 @@ OPTIONS
   --help                 show CLI help
 ```
 
-_See code: [src/commands/instance/spawn.ts](src/commands/instance/spawn.ts)_
+_See code: [lib/commands/instance/spawn.js](lib/commands/instance/spawn.js)_
 
 ## `kourou paas:deploy ENVIRONMENT APPLICATIONID IMAGE`
 
@@ -1062,7 +1063,26 @@ OPTIONS
   --token=token      Authentication token
 ```
 
-_See code: [src/commands/paas/deploy.ts](src/commands/paas/deploy.ts)_
+_See code: [lib/commands/paas/deploy.js](lib/commands/paas/deploy.js)_
+
+## `kourou paas:elasticsearch:dump ENVIRONMENT APPLICATIONID DUMPDIRECTORY`
+
+Dump data from the Elasticsearch of a PaaS application
+
+```
+USAGE
+  $ kourou paas:elasticsearch:dump ENVIRONMENT APPLICATIONID DUMPDIRECTORY
+
+ARGUMENTS
+  ENVIRONMENT    Project environment name
+  APPLICATIONID  Application Identifier
+  DUMPDIRECTORY  Directory where to store dump files
+
+OPTIONS
+  --batch-size=batch-size  [default: 2000] Maximum batch size
+  --help                   show CLI help
+  --project=project        Current PaaS project
+```
 
 ## `kourou paas:init PROJECT`
 
@@ -1079,7 +1099,7 @@ OPTIONS
   --help  show CLI help
 ```
 
-_See code: [src/commands/paas/init.ts](src/commands/paas/init.ts)_
+_See code: [lib/commands/paas/init.js](lib/commands/paas/init.js)_
 
 ## `kourou paas:login`
 
@@ -1096,7 +1116,7 @@ OPTIONS
   --username=username  PaaS username
 ```
 
-_See code: [src/commands/paas/login.ts](src/commands/paas/login.ts)_
+_See code: [lib/commands/paas/login.js](lib/commands/paas/login.js)_
 
 ## `kourou paas:logs ENVIRONMENT APPLICATION`
 
@@ -1121,7 +1141,7 @@ OPTIONS
   --until=until      Display logs until a specific absolute (e.g. 2022/12/02 09:41) or relative (e.g. a minute ago) time
 ```
 
-_See code: [src/commands/paas/logs.ts](src/commands/paas/logs.ts)_
+_See code: [lib/commands/paas/logs.js](lib/commands/paas/logs.js)_
 
 ## `kourou paas:snapshots:cat ENVIRONMENT APPLICATIONID`
 
@@ -1144,7 +1164,7 @@ EXAMPLE
   kourou paas:snapshots:cat --project paas-project-myproject api main
 ```
 
-_See code: [src/commands/paas/snapshots/cat.ts](src/commands/paas/snapshots/cat.ts)_
+_See code: [lib/commands/paas/snapshots/cat.js](lib/commands/paas/snapshots/cat.js)_
 
 ## `kourou paas:snapshots:dump ENVIRONMENT APPLICATIONID`
 
@@ -1167,7 +1187,7 @@ EXAMPLE
   kourou paas:snapshots:dump --project paas-project-myproject api main
 ```
 
-_See code: [src/commands/paas/snapshots/dump.ts](src/commands/paas/snapshots/dump.ts)_
+_See code: [lib/commands/paas/snapshots/dump.js](lib/commands/paas/snapshots/dump.js)_
 
 ## `kourou paas:snapshots:restore ENVIRONMENT APPLICATIONID SNAPSHOTID`
 
@@ -1191,7 +1211,7 @@ EXAMPLE
   kourou paas:snapshots:restore --project paas-project-myproject api main snapshot-id
 ```
 
-_See code: [src/commands/paas/snapshots/restore.ts](src/commands/paas/snapshots/restore.ts)_
+_See code: [lib/commands/paas/snapshots/restore.js](lib/commands/paas/snapshots/restore.js)_
 
 ## `kourou profile:export`
 
@@ -1214,7 +1234,7 @@ OPTIONS
   --username=username  [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/profile/export.ts](src/commands/profile/export.ts)_
+_See code: [lib/commands/profile/export.js](lib/commands/profile/export.js)_
 
 ## `kourou profile:import PATH`
 
@@ -1239,7 +1259,7 @@ OPTIONS
   --username=username  [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/profile/import.ts](src/commands/profile/import.ts)_
+_See code: [lib/commands/profile/import.js](lib/commands/profile/import.js)_
 
 ## `kourou realtime:subscribe INDEX COLLECTION [FILTERS]`
 
@@ -1291,7 +1311,7 @@ EXAMPLES
   kourou realtime:subscribe iot-data sensors --display result._source.temperature
 ```
 
-_See code: [src/commands/realtime/subscribe.ts](src/commands/realtime/subscribe.ts)_
+_See code: [lib/commands/realtime/subscribe.js](lib/commands/realtime/subscribe.js)_
 
 ## `kourou redis:list-keys [MATCH]`
 
@@ -1323,7 +1343,7 @@ EXAMPLES
   kourou redis:list-keys "counters/*" --remove
 ```
 
-_See code: [src/commands/redis/list-keys.ts](src/commands/redis/list-keys.ts)_
+_See code: [lib/commands/redis/list-keys.js](lib/commands/redis/list-keys.js)_
 
 ## `kourou role:export`
 
@@ -1346,7 +1366,7 @@ OPTIONS
   --username=username  [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/role/export.ts](src/commands/role/export.ts)_
+_See code: [lib/commands/role/export.js](lib/commands/role/export.js)_
 
 ## `kourou role:import PATH`
 
@@ -1372,7 +1392,7 @@ OPTIONS
   --username=username   [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/role/import.ts](src/commands/role/import.ts)_
+_See code: [lib/commands/role/import.js](lib/commands/role/import.js)_
 
 ## `kourou sdk:execute [CODE]`
 
@@ -1430,7 +1450,7 @@ DESCRIPTION
       - kourou sdk:execute 'return await sdk.server.now()' --editor
 ```
 
-_See code: [src/commands/sdk/execute.ts](src/commands/sdk/execute.ts)_
+_See code: [lib/commands/sdk/execute.js](lib/commands/sdk/execute.js)_
 
 ## `kourou sdk:query CONTROLLER:ACTION`
 
@@ -1531,7 +1551,7 @@ DESCRIPTION
       - kourou admin:loadMappings < mappings.json
 ```
 
-_See code: [src/commands/sdk/query.ts](src/commands/sdk/query.ts)_
+_See code: [lib/commands/sdk/query.js](lib/commands/sdk/query.js)_
 
 ## `kourou user:export`
 
@@ -1583,7 +1603,7 @@ DESCRIPTION
     - kourou user:export --generate-credentials --generated-username content.email
 ```
 
-_See code: [src/commands/user/export.ts](src/commands/user/export.ts)_
+_See code: [lib/commands/user/export.js](lib/commands/user/export.js)_
 
 ## `kourou user:export-mappings`
 
@@ -1606,7 +1626,7 @@ OPTIONS
   --username=username  [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/user/export-mappings.ts](src/commands/user/export-mappings.ts)_
+_See code: [lib/commands/user/export-mappings.js](lib/commands/user/export-mappings.js)_
 
 ## `kourou user:import PATH`
 
@@ -1631,7 +1651,7 @@ OPTIONS
   --username=username  [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/user/import.ts](src/commands/user/import.ts)_
+_See code: [lib/commands/user/import.js](lib/commands/user/import.js)_
 
 ## `kourou user:import-mappings PATH`
 
@@ -1656,7 +1676,7 @@ OPTIONS
   --username=username  [default: anonymous] Kuzzle username (local strategy)
 ```
 
-_See code: [src/commands/user/import-mappings.ts](src/commands/user/import-mappings.ts)_
+_See code: [lib/commands/user/import-mappings.js](lib/commands/user/import-mappings.js)_
 
 ## `kourou vault:add SECRETS-FILE KEY VALUE`
 
@@ -1687,7 +1707,7 @@ EXAMPLE
   kourou vault:add config/secrets.enc.json aws.s3.keyId b61e267676660c314b006b06 --vault-key <vault-key>
 ```
 
-_See code: [src/commands/vault/add.ts](src/commands/vault/add.ts)_
+_See code: [lib/commands/vault/add.js](lib/commands/vault/add.js)_
 
 ## `kourou vault:decrypt FILE`
 
@@ -1717,7 +1737,7 @@ EXAMPLES
   kourou vault:decrypt config/secrets.enc.json -o config/secrets.json --vault-key <vault-key>
 ```
 
-_See code: [src/commands/vault/decrypt.ts](src/commands/vault/decrypt.ts)_
+_See code: [lib/commands/vault/decrypt.js](lib/commands/vault/decrypt.js)_
 
 ## `kourou vault:encrypt FILE`
 
@@ -1758,7 +1778,7 @@ EXAMPLES
   kourou vault:encrypt config/secrets.json -o config/secrets_prod.enc.json --vault-key <vault-key>
 ```
 
-_See code: [src/commands/vault/encrypt.ts](src/commands/vault/encrypt.ts)_
+_See code: [lib/commands/vault/encrypt.js](lib/commands/vault/encrypt.js)_
 
 ## `kourou vault:show SECRETS-FILE [KEY]`
 
@@ -1789,7 +1809,7 @@ EXAMPLES
   kourou vault:show config/secrets.enc.json aws.s3.secretKey --vault-key <vault-key>
 ```
 
-_See code: [src/commands/vault/show.ts](src/commands/vault/show.ts)_
+_See code: [lib/commands/vault/show.js](lib/commands/vault/show.js)_
 
 ## `kourou vault:test SECRETS-FILE`
 
@@ -1814,7 +1834,7 @@ EXAMPLE
   kourou vault:test config/secrets.enc.json --vault-key <vault-key>
 ```
 
-_See code: [src/commands/vault/test.ts](src/commands/vault/test.ts)_
+_See code: [lib/commands/vault/test.js](lib/commands/vault/test.js)_
 <!-- commandsstop -->
 
 # Where does this weird name come from?

package/lib/commands/paas/elasticsearch/dump.d.ts

@@ -0,0 +1,35 @@
+import { flags } from "@oclif/command";
+import { PaasKommand } from "../../../support/PaasKommand";
+declare class PaasEsDump extends PaasKommand {
+    static description: string;
+    static flags: {
+        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+        project: flags.IOptionFlag<string | undefined>;
+        "batch-size": import("@oclif/parser/lib/flags").IOptionFlag<number>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    runSafe(): Promise<void>;
+    /**
+      * @description Get all indexes from the Elasticsearch of the PaaS application.
+      * @returns The indexes.
+      */
+    private getAllIndexes;
+    /**
+      * @description Dump documents from the Elasticsearch of the PaaS application.
+      * @param pitId ID of the PIT opened on Elasticsearch.
+      * @param searchAfter Cursor for dumping documents after a certain one.
+      * @returns The dumped documents.
+      */
+    private dumpDocuments;
+    private dumpAllDocuments;
+    /**
+      * @description Finish the document dumping session.
+      * @param pitId ID of the PIT opened on Elasticsearch.
+      */
+    private finishDump;
+}
+export default PaasEsDump;

package/lib/commands/paas/elasticsearch/dump.js

@@ -0,0 +1,172 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const promises_1 = (0, tslib_1.__importDefault)(require("node:fs/promises"));
+const ndjson_1 = (0, tslib_1.__importDefault)(require("ndjson"));
+const command_1 = require("@oclif/command");
+const PaasKommand_1 = require("../../../support/PaasKommand");
+class PaasEsDump extends PaasKommand_1.PaasKommand {
+    async runSafe() {
+        // Check that the batch size is positive
+        if (this.flags["batch-size"] <= 0) {
+            this.logKo(`The batch size must be greater than zero. (Specified batch size: ${this.flags["batch-size"]})`);
+            process.exit(1);
+        }
+        // Log in to the PaaS
+        const apiKey = await this.getCredentials();
+        await this.initPaasClient({ apiKey });
+        const user = await this.paas.auth.getCurrentUser();
+        this.logInfo(`Logged as "${user._id}" for project "${this.flags.project || this.getProject()}"`);
+        // Create the dump directory
+        await promises_1.default.mkdir(this.args.dumpDirectory, { recursive: true });
+        // Dump the indexes
+        this.logInfo("Dumping Elasticsearch indexes...");
+        const indexesResult = await this.getAllIndexes();
+        await promises_1.default.writeFile(path_1.default.join(this.args.dumpDirectory, "indexes.json"), JSON.stringify(indexesResult));
+        this.logOk("Elasticsearch indexes dumped!");
+        // Dump all the documents
+        this.logInfo("Dumping Elasticsearch documents...");
+        await this.dumpAllDocuments();
+        this.logOk("Elasticsearch documents dumped!");
+        this.logOk(`The dumped files are available under "${path_1.default.resolve(this.args.dumpDirectory)}"`);
+    }
+    /**
+      * @description Get all indexes from the Elasticsearch of the PaaS application.
+      * @returns The indexes.
+      */
+    async getAllIndexes() {
+        const { result } = await this.paas.query({
+            controller: "application/storage",
+            action: "getIndexes",
+            environmentId: this.args.environment,
+            projectId: this.flags.project || this.getProject(),
+            applicationId: this.args.applicationId,
+            body: {},
+        });
+        return result;
+    }
+    /**
+      * @description Dump documents from the Elasticsearch of the PaaS application.
+      * @param pitId ID of the PIT opened on Elasticsearch.
+      * @param searchAfter Cursor for dumping documents after a certain one.
+      * @returns The dumped documents.
+      */
+    async dumpDocuments(pitId, searchAfter) {
+        const { result } = await this.paas.query({
+            controller: "application/storage",
+            action: "dumpDocuments",
+            environmentId: this.args.environment,
+            projectId: this.flags.project || this.getProject(),
+            applicationId: this.args.applicationId,
+            body: {
+                pitId,
+                searchAfter: JSON.stringify(searchAfter),
+                size: this.flags["batch-size"],
+            },
+        });
+        return result;
+    }
+    async dumpAllDocuments() {
+        // Prepare dumping all documents
+        let pitId = "";
+        let searchAfter = [];
+        let dumpedDocuments = 0;
+        let totalDocuments = 0;
+        const fd = await promises_1.default.open(path_1.default.join(this.args.dumpDirectory, "documents.jsonl"), "w");
+        const writeStream = fd.createWriteStream();
+        const ndjsonStream = ndjson_1.default.stringify();
+        writeStream.on("error", (error) => {
+            throw error;
+        });
+        ndjsonStream.on("data", (line) => {
+            writeStream.write(line);
+        });
+        const teardown = async () => {
+            // Finish the dump session if a PIT ID is set
+            if (pitId.length > 0) {
+                await this.finishDump(pitId);
+            }
+            // Close the open streams/file
+            writeStream.close();
+            await fd.close();
+        };
+        try {
+            // Dump the first batch
+            let result = await this.dumpDocuments(pitId, searchAfter);
+            let hits = result.hits.hits;
+            while (hits.length > 0) {
+                // Update the PIT ID and the cursor for the next dump
+                pitId = result.pit_id;
+                searchAfter = hits[hits.length - 1].sort;
+                // Save the documents
+                for (let i = 0; i < hits.length; ++i) {
+                    ndjsonStream.write(hits[i]);
+                }
+                dumpedDocuments += hits.length;
+                totalDocuments = result.hits.total.value;
+                this.logInfo(`Dumping Elasticsearch documents: ${Math.floor(dumpedDocuments / totalDocuments * 100)}% (${dumpedDocuments}/${totalDocuments})`);
+                // Dump the next batch
+                result = await this.dumpDocuments(pitId, searchAfter);
+                hits = result.hits.hits;
+            }
+        }
+        catch (error) {
+            teardown();
+            this.logKo(`Error while dumping the documents: ${error}`);
+            process.exit(1);
+        }
+        // Finish the dump
+        teardown();
+    }
+    /**
+      * @description Finish the document dumping session.
+      * @param pitId ID of the PIT opened on Elasticsearch.
+      */
+    async finishDump(pitId) {
+        try {
+            await this.paas.query({
+                controller: "application/storage",
+                action: "finishDumpDocuments",
+                environmentId: this.args.environment,
+                projectId: this.flags.project || this.getProject(),
+                applicationId: this.args.applicationId,
+                body: {
+                    pitId,
+                },
+            });
+        }
+        catch (error) {
+            this.logInfo(`Unable to cleanly finish the dump session: ${error}`);
+        }
+    }
+}
+PaasEsDump.description = "Dump data from the Elasticsearch of a PaaS application";
+PaasEsDump.flags = {
+    help: command_1.flags.help(),
+    project: command_1.flags.string({
+        description: "Current PaaS project",
+    }),
+    "batch-size": command_1.flags.integer({
+        description: "Maximum batch size",
+        default: 2000,
+    }),
+};
+PaasEsDump.args = [
+    {
+        name: "environment",
+        description: "Project environment name",
+        required: true,
+    },
+    {
+        name: "applicationId",
+        description: "Application Identifier",
+        required: true,
+    },
+    {
+        name: "dumpDirectory",
+        description: "Directory where to store dump files",
+        required: true,
+    }
+];
+exports.default = PaasEsDump;

package/lib/commands/paas/snapshots/restore.js

@@ -14,10 +14,7 @@ class PaasSnapshotsRestore extends PaasKommand_1.PaasKommand {
             environmentId: this.args.environment,
             projectId: this.flags.project || this.getProject(),
             applicationId: this.args.applicationId,
-            body: {
-                repository: "automated",
-                snapshot: this.args.snapshotId,
-            },
+            snapshotId: this.args.snapshotId
         });
         this.logInfo("Ok");
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kourou",
   "description": "The CLI that helps you manage your Kuzzle instances",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "bin": {
     "kourou": "./bin/run"
@@ -42,6 +42,7 @@
     "tar": "^6.1.11",
     "tmp": "^0.2.1",
     "tslib": "^2.3.1",
+    "typescript": "4.4.*",
     "ws": "^8.8.0"
   },
   "devDependencies": {
@@ -55,7 +56,7 @@
     "@types/listr": "^0.14.2",
     "@types/mocha": "^8.2.2",
     "@types/ndjson": "^2.0.0",
-    "@types/node": "^14.14.41",
+    "@types/node": "^18.19.0",
     "@types/node-emoji": "^1.8.1",
     "@types/node-fetch": "^2.6.1",
     "@types/tar": "^6.1.3",
@@ -72,8 +73,7 @@
     "prettier-eslint": "^12.0.0",
     "should": "^13.2.3",
     "source-map-support": "^0.5.19",
-    "ts-node": "10.9.*",
-    "typescript": "4.4.*"
+    "ts-node": "10.9.*"
   },
   "engines": {
     "node": ">=10.0.0"