Add support for compacting database indexes #728

kumarUjjawal · 2025-11-05T09:56:45Z

Pull Request

Related issue

Fixes #727

What does this PR do?

I noticed a typo in the .code-samples.meilisearch.yaml so fixed that as well.

PR checklist

Please check if your PR fulfills the following requirements:

Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
Have you read the contributing guidelines?
Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

New Features
- Added ability to trigger index compaction and monitor its completion as an async task.
Tests
- Added a test to verify index compaction completes successfully.
Documentation
- Added a compact-index code sample.
- Fixed typos in field properties guide examples (corrected "overview" in searchable and displayed attributes).

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-11-05T09:56:57Z

Walkthrough

Adds index compaction support: new async Index::compact() method that POSTs to /indexes/{uid}/compact and returns TaskInfo; adds TaskType::IndexCompaction and IndexCompaction details struct; includes code sample entry and a test that awaits compaction.

Changes

Cohort / File(s)	Summary
Code examples `.code-samples.meilisearch.yaml`	Added `compact_index_1` example calling `index("INDEX_UID").compact().await.unwrap()`; fixed typos by replacing `"overvieww"` with `"overview"` in `field_properties_guide_searchable_1` and `field_properties_guide_displayed_1`.
Index API `src/indexes.rs`	Added `pub async fn compact(&self) -> Result<TaskInfo, Error>` on `Index<Http>` and a test `test_compact_index_succeeds` that triggers compaction and awaits the returned task.
Task types `src/tasks.rs`	Added `pub struct IndexCompaction` (derives Debug, Clone, Deserialize; `serde(rename_all = "camelCase")`) and new `TaskType::IndexCompaction { details: Option<IndexCompaction> }` variant.
Manifest `Cargo.toml`	No public API changes noted; included in diff list (likely metadata or dependency updates).

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SDK
    participant MeiliServer

    User->>SDK: call index.compact().await
    SDK->>MeiliServer: POST /indexes/{uid}/compact
    MeiliServer-->>SDK: 202 Accepted + TaskInfo
    SDK-->>User: returns Ok(TaskInfo)
    Note right of SDK: TaskInfo can be polled for completion separately

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Verify HTTP request path and method in compact() and correct serialization/deserialization of TaskInfo.
Review IndexCompaction struct fields and serde attributes against Meilisearch v1.23 spec.
Check the test test_compact_index_succeeds for proper async handling and flakiness risk.
Confirm example entry in .code-samples.meilisearch.yaml matches SDK usage patterns.

Poem

🐰
I nudged the index, snug and light,
Sent a POST into the night,
A TaskInfo hopped back with glee,
I watched it finish — tidy, free.

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Add support for compacting database indexes' directly and clearly summarizes the main change: adding SDK support for the Meilisearch compact database API endpoint.
Linked Issues check	✅ Passed	The PR implements all three coding requirements from issue #727: adds the compact() method to Index [#727], includes a test case (test_compact_index_succeeds) [#727], and adds the compact_index_1 code sample to .code-samples.meilisearch.yaml [#727].
Out of Scope Changes check	✅ Passed	All changes are in-scope: the compact() method and test address the main objective, the IndexCompaction struct and TaskType variant support the API integration, and the typo fix in YAML and code sample addition fulfill additional requirements.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ffb025f and 1bc40e9.

📒 Files selected for processing (1)

.code-samples.meilisearch.yaml (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

.code-samples.meilisearch.yaml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: integration-tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codecov · 2025-11-05T10:05:17Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.22%. Comparing base (e90a3c2) to head (ffb025f).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #728      +/-   ##
==========================================
+ Coverage   86.18%   86.22%   +0.03%     
==========================================
  Files          20       20              
  Lines        6263     6285      +22     
==========================================
+ Hits         5398     5419      +21     
- Misses        865      866       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

curquiza

bors merge

724: Add method to get documents by ID r=curquiza a=kumarUjjawal # Pull Request ## Related issue Fixes #662 ## What does this PR do? - Added a method to get the documents by ID - also added code samples ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch!  ## Summary by CodeRabbit * **New Features** * Added capability to retrieve documents by their IDs for more targeted queries. * **Documentation** * Added code sample demonstrating ID-based document retrieval.  725: Update diesel-async requirement from 0.6.1 to 0.7.3 r=curquiza a=dependabot[bot] Updates the requirements on [diesel-async](https://github.com/weiznich/diesel_async) to permit the latest version. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/weiznich/diesel_async/releases">diesel-async's releases</a>.</em></p> <blockquote> <h2>Diesel-Async 0.7.3</h2> <ul> <li>Another attempt to fix the docs.rs build by <a href="https://github.com/paolobarbolini"><code>`@paolobarbolini</code></a></li>` </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/weiznich/diesel_async/compare/v0.7.2...v0.7.3">https://github.com/weiznich/diesel_async/compare/v0.7.2...v0.7.3</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/weiznich/diesel_async/blob/main/CHANGELOG.md">diesel-async's changelog</a>.</em></p> <blockquote> <h2>[0.7.3] - 2025-10-05</h2> <ul> <li>Another docs.rs build fix</li> </ul> <h2>[0.7.2] - 2025-10-02</h2> <ul> <li>Fix versions in the Readme</li> </ul> <h2>[0.7.1] - 2025-10-02</h2> <ul> <li>Fix the docs.rs build</li> </ul> <h2>[0.7.0] - 2025-10-02</h2> <ul> <li>Support for diesel 2.3</li> <li>Added support for running migrations via <code>AsyncMigrationHarness</code></li> <li>Improved ergonomics of using query pipelining with <code>AsyncPgConnection</code></li> <li>Added the ability to cancel queries using <code>AsyncMysqlConnection::cancel_token</code></li> </ul> <h2>[0.6.1] - 2025-07-03</h2> <ul> <li>Fix features for some dependencies</li> </ul> <h2>[0.6.0] - 2025-07-02</h2> <ul> <li>Allow to control the statement cache size</li> <li>Minimize dependencies features</li> <li>Bump minimal supported mysql_async version to 0.36.0</li> <li>Fixing a bug in how we tracked open transaction that could lead to dangling transactions is specific cases</li> </ul> <h2>[0.5.2] - 2024-11-26</h2> <ul> <li>Fixed an issue around transaction cancellation that could lead to connection pools containing connections with dangling transactions</li> </ul> <h2>[0.5.1] - 2024-11-01</h2> <ul> <li>Add crate feature <code>pool</code> for extending connection pool implements through external crate</li> <li>Implement <code>Deref</code> and <code>DerefMut</code> for <code>AsyncConnectionWrapper</code> to allow using it in an async context as well</li> </ul> <h2>[0.5.0] - 2024-07-19</h2> <ul> <li>Added type <code>diesel_async::pooled_connection::mobc::PooledConnection</code></li> <li>MySQL/MariaDB now use <code>CLIENT_FOUND_ROWS</code> capability to allow consistent behaviour with PostgreSQL regarding return value of UPDATe commands.</li> <li>The minimal supported rust version is now 1.78.0</li> <li>Add a <code>SyncConnectionWrapper</code> type that turns a sync connection into an async one. This enables SQLite support for diesel-async</li> <li>Add support for <code>diesel::connection::Instrumentation</code> to support logging and other instrumentation for any of the provided connection impls.</li> <li>Bump minimal supported mysql_async version to 0.34</li> </ul> <h2>[0.4.1] - 2023-09-01</h2>  </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/weiznich/diesel_async/commit/e5e71da49416159f593f4896375e5e5c3a3b103c"><code>e5e71da</code></a> Prepare a 0.7.3 release to finally fix the docs.rs build</li> <li><a href="https://github.com/weiznich/diesel_async/commit/dacc14b0148a0a7dceb3337d0aeb2577bce67d4e"><code>dacc14b</code></a> Merge pull request <a href="https://redirect.github.com/weiznich/diesel_async/issues/265">#265</a> from paolobarbolini/no-docsrs-in-rustc</li> <li><a href="https://github.com/weiznich/diesel_async/commit/4ae157321ebf3bcd69264765bd43400449f6aaa1"><code>4ae1573</code></a> Fix docs.rs build by avoiding <code>--cfg docsrs</code> in rustc flags</li> <li><a href="https://github.com/weiznich/diesel_async/commit/46cd5fed6b7ac0a7f7b1b6e1a1283fece3813fe9"><code>46cd5fe</code></a> Fix versions in the readme</li> <li><a href="https://github.com/weiznich/diesel_async/commit/d5ac63e13307077babf976e02ef6bbab8353f079"><code>d5ac63e</code></a> Fix docs.rs build</li> <li><a href="https://github.com/weiznich/diesel_async/commit/df4c823d38d0c4e1e8d78bff5977986c8107068d"><code>df4c823</code></a> Explicitly specify what should be published and what not</li> <li><a href="https://github.com/weiznich/diesel_async/commit/4c449530625df0580ef9d19a055109a2385ae90a"><code>4c44953</code></a> Merge pull request <a href="https://redirect.github.com/weiznich/diesel_async/issues/264">#264</a> from weiznich/prepare/0.7.0</li> <li><a href="https://github.com/weiznich/diesel_async/commit/d0c4ea025d85616f95d368b951f92ff784ed721a"><code>d0c4ea0</code></a> Prepare a 0.7.0 release</li> <li><a href="https://github.com/weiznich/diesel_async/commit/356919091e47968ca2dcc534b533cf4cb62de958"><code>3569190</code></a> Merge pull request <a href="https://redirect.github.com/weiznich/diesel_async/issues/262">#262</a> from stormshield-kg/fix-hrtb-errors</li> <li><a href="https://github.com/weiznich/diesel_async/commit/661de8c4442a123ccde74001b44fc6a154dbc4b2"><code>661de8c</code></a> Replace hand written future impls</li> <li>Additional commits viewable in <a href="https://github.com/weiznich/diesel_async/compare/v0.6.1...v0.7.3">compare view</a></li> </ul> </details> <br /> You can trigger a rebase of this PR by commenting ``@dependabot` rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - ``@dependabot` rebase` will rebase this PR - ``@dependabot` recreate` will recreate this PR, overwriting any edits that have been made to it - ``@dependabot` merge` will merge this PR after your CI passes on it - ``@dependabot` squash and merge` will squash and merge this PR after your CI passes on it - ``@dependabot` cancel merge` will cancel a previously requested merge and block automerging - ``@dependabot` reopen` will reopen this PR if it is closed - ``@dependabot` close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - ``@dependabot` show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - ``@dependabot` ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - ``@dependabot` ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - ``@dependabot` ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> 726: Add exhaustive facet search r=curquiza a=kumarUjjawal # Pull Request ## Related issue Fixes #664 ## What does this PR do? - ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch!  ## Summary by CodeRabbit * **New Features** * Results now include a flag indicating whether facet counts are exact or estimated, so callers can know when displayed facet totals are definitive. * Added an optional query setting and a builder-style method to request exhaustive (exact) facet counts when performing searches, giving users control over accuracy vs. performance.  728: Add support for compacting database indexes r=curquiza a=kumarUjjawal # Pull Request ## Related issue Fixes #727 ## What does this PR do? - I noticed a typo in the `.code-samples.meilisearch.yaml` so fixed that as well. - ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch!  ## Summary by CodeRabbit * **New Features** * Added ability to perform index compaction and monitor its completion as an async task. * **Documentation** * Added compact index code sample. * Fixed typos in field properties guide examples (corrected "overview" in searchable and displayed attributes).  Co-authored-by: Kumar Ujjawal <ujjawalpathak6@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

meili-bors · 2025-11-20T18:55:30Z

This PR was included in a batch that successfully built, but then failed to merge into main. It will not be retried.

Additional information:

{"message":"Changes must be made through a pull request.","documentation_url":"https://docs.github.com/articles/about-protected-branches","status":"422"}

curquiza · 2025-11-21T09:19:51Z

bors merge

meili-bors · 2025-11-21T09:27:30Z

Build succeeded:

Add support for compacting database indexes

23fd9c6

Fixed typo in the code sample for searchable properties

ffb025f

curquiza approved these changes Nov 20, 2025

View reviewed changes

curquiza added the enhancement New feature or request label Nov 20, 2025

Merge branch 'main' into feat/compact

1bc40e9

meili-bors bot merged commit d725a3c into meilisearch:main Nov 21, 2025
8 of 9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add support for compacting database indexes #728

Add support for compacting database indexes #728

Uh oh!

kumarUjjawal commented Nov 5, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 5, 2025 •

edited

Loading

Uh oh!

codecov bot commented Nov 5, 2025 •

edited

Loading

Uh oh!

curquiza left a comment

Uh oh!

meili-bors bot commented Nov 20, 2025

Uh oh!

curquiza commented Nov 21, 2025

Uh oh!

meili-bors bot commented Nov 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add support for compacting database indexes #728

Add support for compacting database indexes #728

Uh oh!

Conversation

kumarUjjawal commented Nov 5, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Related issue

What does this PR do?

PR checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

codecov bot commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

curquiza left a comment

Choose a reason for hiding this comment

Uh oh!

meili-bors bot commented Nov 20, 2025

Uh oh!

curquiza commented Nov 21, 2025

Uh oh!

meili-bors bot commented Nov 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kumarUjjawal commented Nov 5, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 5, 2025 •

edited

Loading

codecov bot commented Nov 5, 2025 •

edited

Loading