Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add methods to configure new prefixSearch and facetSearch index settings #702

Merged
merged 6 commits into from
Dec 6, 2024

Conversation

Strift
Copy link
Collaborator

@Strift Strift commented Dec 5, 2024

Pull Request

Related issue

Fixes #694

What does this PR do?

  • Add tests to make sure getSettings(), and updateSettings allow the new settings
  • Add the getFacetSearch(), updateFacetSearch(), and resetFacetSearch() methods
  • Add the getPrefixSearch(), updatePrefixSearch(), and resetPrefixSearch() methods
  • Add tests

@Strift Strift linked an issue Dec 5, 2024 that may be closed by this pull request
4 tasks
@Strift Strift requested a review from norkunas December 5, 2024 09:52
@Strift
Copy link
Collaborator Author

Strift commented Dec 5, 2024

Hey @norkunas 👋 I went ahead I tagged you as a reviewer since you helped me with the previous PRs. I hope you can assist me with reviewing this one too. 🙏

// Settings - Facet Search

/**
* @since Meilisearch v1.12.0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we really need this annotation (everywhere)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't say we need it to the point where we should update all the code base. But if it shows up in the generated documentation, then it's useful information for the reader. What do you think?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok

@Strift Strift merged commit 3e0a026 into bump-meilisearch-v0.12.0 Dec 6, 2024
30 checks passed
@Strift Strift deleted the feat/add-v1.12-settings branch December 6, 2024 07:43
@Strift Strift changed the title Add prefixSearch and facetSearch index settings Add methods to configure new prefixSearch and facetSearch index settings Dec 11, 2024
meili-bors bot added a commit that referenced this pull request Dec 23, 2024
692: Changes related to the next Meilisearch release (v1.12.0) r=curquiza a=meili-bot

Related to this issue: meilisearch/integration-guides#307

This PR:
- gathers the changes related to the next Meilisearch release (v1.12.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest pre-release of Meilisearch](https://github.com/meilisearch/meilisearch/releases).
- might eventually contain test failures until the Meilisearch v1.12.0 is out.

⚠️ This PR should NOT be merged until the next release of Meilisearch (v1.12.0) is out.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/main/resources/pre-release-week.md) purpose._


705: Update version for the next release (v1.12.0) r=curquiza a=meili-bot

_This PR is auto-generated._

The automated script updates the version of meilisearch-php to a new version: "v1.12.0"

CHANGELOGS 👇

This version introduces features released on Meilisearch v1.12.0 🎉

Check out the [Meilisearch v1.12.0 changelog](https://github.com/meilisearch/meilisearch/releases/tag/v1.12.0) for more information.

## 🚀 Enhancements

- **Addition:** #699

Introducing new methods to get one or several batches, respectively `getBatch()` and `getBatches()`. A batch is a set of tasks processed together.

- **Addition:** #698

The `TaskQuery` class now has a `setReverse()` method to retrieve tasks in reverse chronological order.

```php
client->getTasks((new TasksQuery())->setReverse(true));
```

- **Addition:** #702

Index settings now allow disabling **prefix search** and **facet search**. They're both enabled by default. The SDK now comes with dedicated methods to configure these settings.

```php
// disable prefix search
$index->updatePrefixSearch('disabled');
// reset prefix search settings
$index->resetPrefixSearch();

// disable facet search
$index->updateFacetSearch(false);
// reset facet search settings
$index->resetFacetSearch();
```

## 🐛 Bug Fixes

- fix: pull the latest in the CI instead of forcing the v1.11 (#691) `@/mdubus`
- Make `hitsCount` always the number of `hits` (and not `totalHits` value) (#701) `@/johnnynotsolucky`

## ⚙️ Maintenance/misc

- Update CI to run with PHP 8.4 (#696) `@/norkunas`
- Fixed SearchNestedFieldsTest test (#704) `@/aivchen`
- PHPStan 2 + fixed uninitialized properties in SearchResult (#706) `@/aivchen`

Thanks again to `@/aivchen,` `@/johnnynotsolucky,` `@/mdubus,` `@/norkunas,` Andrei Ivchenkov, and `@/Strift!` 🎉

Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Clémentine <[email protected]>
Co-authored-by: Strift <[email protected]>
Co-authored-by: Laurent Cazanove <[email protected]>
meili-bors bot added a commit that referenced this pull request Dec 23, 2024
705: Update version for the next release (v1.12.0) r=curquiza a=meili-bot

_This PR is auto-generated._

The automated script updates the version of meilisearch-php to a new version: "v1.12.0"

CHANGELOGS 👇

This version introduces features released on Meilisearch v1.12.0 🎉

Check out the [Meilisearch v1.12.0 changelog](https://github.com/meilisearch/meilisearch/releases/tag/v1.12.0) for more information.

## 🚀 Enhancements

- **Addition:** #699

Introducing new methods to get one or several batches, respectively `getBatch()` and `getBatches()`. A batch is a set of tasks processed together.

- **Addition:** #698

The `TaskQuery` class now has a `setReverse()` method to retrieve tasks in reverse chronological order.

```php
client->getTasks((new TasksQuery())->setReverse(true));
```

- **Addition:** #702

Index settings now allow disabling **prefix search** and **facet search**. They're both enabled by default. The SDK now comes with dedicated methods to configure these settings.

```php
// disable prefix search
$index->updatePrefixSearch('disabled');
// reset prefix search settings
$index->resetPrefixSearch();

// disable facet search
$index->updateFacetSearch(false);
// reset facet search settings
$index->resetFacetSearch();
```

## 🐛 Bug Fixes

- fix: pull the latest in the CI instead of forcing the v1.11 (#691) `@/mdubus`
- Make `hitsCount` always the number of `hits` (and not `totalHits` value) (#701) `@/johnnynotsolucky`

## ⚙️ Maintenance/misc

- Update CI to run with PHP 8.4 (#696) `@/norkunas`
- Fixed SearchNestedFieldsTest test (#704) `@/aivchen`
- PHPStan 2 + fixed uninitialized properties in SearchResult (#706) `@/aivchen`

Thanks again to `@/aivchen,` `@/johnnynotsolucky,` `@/mdubus,` `@/norkunas,` Andrei Ivchenkov, and `@/Strift!` 🎉

Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Clémentine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[v1.12.0] New settings: facetSearch & prefixSearch
2 participants