Implement index:stats

doc/7/controllers/index/stats/index.md

@@ -0,0 +1,41 @@
+---
+code: true
+type: page
+title: stats
+description: Gets detailed storage statistics
+---
+
+# stats
+
+<SinceBadge version="Kuzzle 2.10.0"/>
+<SinceBadge version="auto-version"/>
+
+Gets detailed storage usage statistics.
+
+<br/>
+
+```js
+stats([options]);
+```
+
+<br/>
+
+| Arguments | Type              | Description   |
+| --------- | ----------------- | ------------- |
+| `options` | <pre>object</pre> | Query options |
+
+### options
+
+Additional query options
+
+| Property   | Type<br/>(default)              | Description                                                                  |
+| ---------- | ------------------------------- | ---------------------------------------------------------------------------- |
+| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
+
+## Resolves
+
+Returns detailed storage usage statistics: overall index/collection sizes and the number of documents per collection.
+
+## Usage
+
+<<< ./snippets/stats.js

doc/7/controllers/index/stats/snippets/stats.js

@@ -0,0 +1,21 @@
+const stats = await kuzzle.index.stats();
+
+console.log(JSON.stringify(stats));
+/*
+  {
+    "indexes":[
+      {
+        "name":"nyc-open-data",
+        "size":42,
+        "collections":[
+          {
+            "name":"yellow-taxi",
+            "documentCount":42,
+            "size":42
+          }
+        ]
+      }
+    ],
+    "size":42
+  }
+*/

doc/7/controllers/index/stats/snippets/stats.test.yml

@@ -0,0 +1,10 @@
+---
+name: index#stats
+description: Gets detailed storage statistics
+hooks:
+  before: |
+    curl -X POST kuzzle:7512/nyc-open-data/_create
+    curl -XPUT kuzzle:7512/nyc-open-data/yellow-taxi
+  after: curl -X DELETE kuzzle:7512/nyc-open-data
+template: catch
+expected: ["documentCount":0]

src/controllers/Index.ts

@@ -1,4 +1,5 @@
 import { BaseController } from './Base';
+import { JSONObject } from '../types';
 
 export class IndexController extends BaseController {
 
@@ -99,4 +100,19 @@ export class IndexController extends BaseController {
     return this.query(request, options)
       .then(response => response.result.deleted);
   }
+
+  /**
+   * Returns detailed storage usage statistics.
+   *
+   * @see https://docs.kuzzle.io/sdk/js/7/controllers/index/stats/
+   *
+   * @param options Additional options
+   *    - `queuable` If true, queues the request during downtime, until connected to Kuzzle again
+   */
+  stats (options: { queuable?: boolean } = {}): Promise<JSONObject> {
+    return this.query({
+      action: 'stats'
+    }, options)
+      .then(response => response.result);
+  }
 }

test/controllers/index.test.js

@@ -120,4 +120,37 @@ describe('Index Controller', () => {
         });
     });
   });
+
+  describe('stats', () => {
+    it('should call index/stats query and return a Promise which resolves to an object containing detailed storage statistics', () => {
+      const result = {
+        indexes: [
+          {
+            name: 'nyc-open-data',
+            size: 42,
+            collections: [
+              {
+                name: 'yellow-taxi',
+                documentCount: 42,
+                size: 42,
+              }
+            ]
+          }
+        ]
+      };
+      kuzzle.query.resolves({result});
+
+      return kuzzle.index.stats(options)
+        .then(res => {
+          should(kuzzle.query)
+            .be.calledOnce()
+            .be.calledWith({
+              controller: 'index',
+              action: 'stats'
+            }, options);
+
+          should(res).be.equal(result);
+        });
+    });
+  });
 });