v1.5.0 🐘

This version introduces features released on Meilisearch v1.5.0 🎉
Check out the changelog of Meilisearch v1.5.0 for more information on the changes.

⚠️ If you want to adopt new features of this release, update the Meilisearch server to the appropriate version.

🚀 Enhancements

• Needs Meilisearch v1.5.0 -> Add new method createSnapshot() to trigger snapshot creation. Similar to the already existing createDump() for dumps (#587) @brunoocasali

⚙️ Maintenance/misc

• Add CI to update library version (#589) @curquiza

v1.4.1 🐘

🐛 Bug Fixes

• Fix an unexpected breaking change in v1.4.0 when passing a empty masterkey (#585) @mmachatschek

Thanks again to @mmachatschek! 🎉

v1.4.0 🐘

This version introduces features released on Meilisearch v1.4.0 🎉
Check out the changelog of Meilisearch v1.4.0 for more information on the changes.

⚠️ If you want to adopt new features of this release, update the Meilisearch server to the according version.

🚀 Enhancements

• Needs Meilisearch v1.4.0 -> Add support for the new setting: dictionary (#574) @alallema

$index->getDictionary();
$index->updateDictionary(['J. R. R.', 'W. E. B.']);
$index->resetDictionary();

• Needs Meilisearch v1.4.0 -> Add support for the new setting: separator-tokens (#574) @alallema

$index->getSeparatorTokens();
$index->updateSeparatorTokens(['|', '…']);
$index->resetSeparatorTokens();

• Needs Meilisearch v1.4.0 -> Add support for the new setting: non-separator-tokens (#574) @alallema

$index->getNonSeparatorTokens();
$index->updateNonSeparatorTokens(['@', '#']);
$index->resetNonSeparatorTokens();

⚠️ Warning usage with v1.4.0

A bug fix in Meilisearch v1.4.0 introduces a breaking change in the filter usage. It only concerns users using the filter search parameter with \.
Explanation and change to apply are detailed in the Meilisearch v1.4.0

Thanks again to @alallema, @brunoocasali, @curquiza, @dependabot, @dependabot[bot], @meili-bors[bot], and @norkunas! 🎉

v1.3.0 🐘

This version introduces features released on Meilisearch v1.3.0 🎉
Check out the changelog of Meilisearch v1.3.0 for more information on the changes.

⚠️ If you want to adopt new features of this release, update the Meilisearch server to the according version.

🚀 Enhancements

• Add a base exception interface all exceptions must implement (#534) @94noni
• ⚠️ EXPERIMENTAL: setShowRankingScoreDetails and search(['showRankingScoreDetails' => boolean]) to show the scores of each relevant document returned in the search.
• ⚠️ EXPERIMENTAL: setVector and search(['vector' => [...]]) to enable vector search capabilities.
• Add setAttributesToSearchOn and search(['attributesToSearchOn' => [...]])
• index->facetSearch(FacetSearchQuery params) to search only in facets.

⚠️ The EXPERIMENTAL features are not covered by semver. To explicitly opt-in, check this guide.

💅 Misc

• Migrate docs hosting to Meilisearch subdomain (#553) @Strift
• Update SDK docs link in README.md (#556) @Strift
• [DX] Improve quality of Client class & related (#514) @stloyd
• [DX] Add support for PHPUnit 10.1 (#516) @stloyd

Thanks again to @94noni, @Strift, @alallema, @brunoocasali, @norkunas and @stloyd! 🎉

v1.2.1 🐘

🐛 Bug Fixes

• Fix fetching documents by getDocuments with filters and fields being set in DocumentsQuery (#523) @panzer-punk
• Remove duplicated key on code-samples (#520) @justkahdri

Thanks again to @justkahdri, @panzer-punk! 🎉

v1.2.0 🐘

This version introduces features released on Meilisearch v1.2.0 🎉
Check out the changelog of Meilisearch v1.2.0 for more information on the changes.
⚠️ If you want to adopt new features of this release, update the Meilisearch server to the according version.

🚀 Enhancements

• The method deleteDocuments() now supports a different behavior. This method could take an array containing a filter key with the filter value, which will filter and delete the documents. #509 @brunoocasali

  ⚠️ You must configure the attributes you want to filter using the Index\filterableAttributes().
  ⚠️ Remember to update your Meilisearch server to v1.2.0 or newer before adopting it.

  Still, even being supported, the ability to receive only a list of ids is deprecated, and it will be removed in meilisearch-php v2

• Add the ability to setFilter in the DocumentsQuery. When a query with a filter is sent to getDocuments(DocumentsQuery $query) it will filter the documents similar to the search method. See the docs on how to use filters. #510 @brunoocasali

  ⚠️ You must configure the attributes you want to filter using the Index\filterableAttributes().
  ⚠️ Remember to update your Meilisearch server to v1.2.0 or newer before adopting it.

Thanks again to @brunoocasali, @tacman, @norkunas! 🎉

v1.1.0

This version introduces features released on Meilisearch v1.1.0 🎉
Check out the changelog of Meilisearch v1.1.0 for more information on the changes.
If you want to adopt new features of this release, update the Meilisearch server to the according version.

🚀 Enhancements

• Add a new optional argument to addDocumentsCsv, addDocumentsCsvInBatches, and updateDocumentsCsvInBatches. This argument allows you to customize the separator character in your csv file. (#480) @brunoocasali
• Add a new getter, the facetStats on SearchResult (#487) @brunoocasali.
• Add $client->multiSearch() method to execute multiple search requests simultaneously with different configurations. (#481) @brunoocasali

  • Introduce SearchQuery builder class to build the search requests used in the multiSearch.
    Usage example:

    $this->client->multiSearch([
      (new SearchQuery())->setIndexUid('books')
          ->setQuery('princ')
          ->setSort(['author:desc']),
      (new SearchQuery())->setIndexUid('movies')
          ->setQuery('be')
          ->setHitsPerPage(4)
          ->setFilter(['duration-float > 3']),
    ]);

  ⚠️ The SearchQuery was not meant to be used if the regular $index->search() requests (yet).

v1.0.0 🐘

This version makes this package compatible with Meilisearch v1.0.0 🎉
Check out the changelog of Meilisearch v1.0.0 for more information on the changes.

💥 Breaking Changes

• Endpoints/Indexes date attributes $createdAt and $updatedAt are DateTime now instead of string. (#457) @brunoocasali
  • Removed getCreatedAtString and getUpdatedAtString functions.
• Add canceledBy/setCanceledBy in TasksQuery (#454) @brunoocasali
• Remove next attribute and setNext from TasksQuery. (#454) @brunoocasali
• Remove next attribute and setNext from DeleteTasksQuery. (#454) @brunoocasali
• Remove next, canceledBy attributes and setNext, setCanceledBy from CancelTasksQuery. (#454) @brunoocasali
• Remove deleteAllIndexes, since they don't really delete all the indexes but only the first page. (#454) @brunoocasali
• Remove getAllRawIndexes function. (#454) @brunoocasali
• Rename getAllIndexes to getIndexes. (#454) @brunoocasali
• Move all traits to src/Endpoints/Delegates. (#455) @brunoocasali
  • Meilisearch\Delegates\HandlesIndex to Meilisearch\Endpoints\Delegates\HandlesIndex
  • Meilisearch\Delegates\HandlesSystem to Meilisearch\Endpoints\Delegates\HandlesSystem
  • Meilisearch\Delegates\TasksQueryTrait to Meilisearch\Endpoints\Delegates\TasksQueryTrait

Enhancements

• Add PHP 8.2 to CI (#448) @norkunas

Thanks again to @brunoocasali and @norkunas! 🎉

v0.27.0 🐘

⚠️ This release has nothing new, and it is just a tag to mark the previous release v0.26.1 as breaking, so v0.27.0.

You should be careful because every occurrence of MeiliSearch, even in the file names were changed to Meilisearch.

More details in the comments section here and here.

---

Original changelog from v0.26.1:

🚀 Enhancements

• Change casing of MeiliSearch to Meilisearch (#431) @mmachatschek

⚠️ If you handle ::class directly, a change is required, as pointed out #431 (comment)

Thanks again to @brunoocasali and @mmachatschek! 🎉

[DEPRECATED] v0.26.1 🐘

🚀 Enhancements

• Change casing of MeiliSearch to Meilisearch (#431) @mmachatschek

⚠️ If you handle ::class directly, a change is required, as pointed out #431 (comment)

Thanks again to @brunoocasali and @mmachatschek! 🎉