Prototype: Meilisearch finite pagination beta

[brunoocasali]

This branch will not be merged until the team defines the fate of the finite pagination, you can read more here.

⚠️ This code can change in the future, and it is not protected by tags, be careful.

Installing:

composer require meilisearch/meilisearch-php:"dev-meilisearch-finite-pagination-beta as v0.24.3.beta"

Searching:

Basic search now responds directly with the new pagination.

$results = client->search("botman"); // SearchResult

{
  "hits":[…],
  "query":"botman",
  "processingTimeMs":5,
  "hitsPerPage":20,
  "page":1,
  "totalPages":4,
  "totalHits": 52
}

You can request a specific search results page using the page search parameter. Defaults to 1.

$results = client->search("botman", ["page" => 2]);

You can also set the max number of hits per page. Defaults to 20.

$results = client->search("botman", ["hitsPerPage" => 15]);

To disable exhaustive pagination, your query must include either limit or offset. Meilisearch will return estimatedTotalHits instead of hitsPerPage, page, totalPages, and totalHits.

$results = client->search("botman", ["offset" => 0]); // SearchResult

{
  "hits":[…],
  "query":"botman",
  "processingTimeMs":3,
  "limit":20,
  "offset":0,
  "estimatedTotalHits":66
}

⚠️ ⚠️ 🎉 🎉
Any suggestion related to PHP implementation can be made here, but anything related to Meilisearch's public API should be done in the appropriate discussion.

[bidoubiwa]

I'm not sure I understand the logic here.

Are you requiring that the branch ends with -beta in order for the normal tests to run?

[bidoubiwa]

Shouln't it be this:

    if: (!endsWith(github.base_ref, '-beta') || github.event_name != 'pull_request' || !startsWith(github.base_ref, 'bump-meilisearch-v'))

?

[brunoocasali]

Closing it since it was added in v0.26.0