Skip to content

[Meilisearch v1.44.0] Add human-formatted sizes and detailed DB sizes in stats #1234

@Strift

Description

@Strift

Context

[Meilisearch 1.44.0]https://github.com/meilisearch/meilisearch/releases/tag/v1.44.0) introduces human-formatted sizes and detailed DB sizes in stats.

Objective

Update the corresponding SDK methods:

Both related API endpoints now accept new query parameters:

  • showInternalDatabaseSizes: boolean, optional, defaults to false. When present, the index stat objects in responses of the stat routes now contain an additional internalDatabaseSizes key, whose value is a dictionary of the internal database names and their current size in the index, like in the stats object of a batch.
  • sizeFormat: human or raw: optional, defaults to raw. When present and set to human, then all database sizes in responses of the stat routes will be returned as a string containing an appropriate unit (MiB, GiB, etc). When missing or set to raw, then the current behavior of expressing the size in bytes as a number is retained.

The keys in internalDatabaseSizes are subject to change and should not be exposed as a strongly typed object.

Tasks

  • Add/update methods to handle interacting with the stats API endpoints
  • Add/update test cases for the new/updated methods
  • Update .code-samples.meilisearch.yaml to add examples under the following keys: get_index_stats_1 and get_indexes_stats_1. It should match the examples in the documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions