stats #

Available since Kuzzle 2.10.0

Available since 7.6.0

Gets detailed storage usage statistics.

stats([options]);

Arguments	Type	Description
`options`	object	Query options

options #

Additional query options

Property	Type (default)	Description
`queuable`	boolean (`true`)	If `true`, queues the request during downtime, until connected to Kuzzle again
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolves #

Returns detailed storage usage statistics: overall index/collection sizes and the number of documents per collection.

Usage #

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
  }
*/

Edit this page on Github