docs: add details about updating index module's data source (#13637)

* docs: add details about updating index module's data source

* small change
This commit is contained in:
Shahed Nasser
2025-10-01 10:26:11 +03:00
committed by GitHub
parent d30806533c
commit 05af008911
3 changed files with 17 additions and 1 deletions
@@ -64,6 +64,8 @@ Finally, run the migrations to create the necessary tables for the Index Module
npx medusa db:migrate
```
### Ingest Data
The Index Module only ingests data when you start your Medusa server. So, to ingest the [currently supported data models](#ingested-data-models), start the Medusa application:
```bash npm2yarn
@@ -91,6 +93,12 @@ info: [Index engine] syncing entity 'SalesChannel'
info: [Index engine] syncing entity 'SalesChannel' done (+7.00ms)
```
### Update Index on Data Changes
The Index Module automatically updates its data store when data in the ingested data models change. So, you don't need to do anything to keep the data in sync.
For example, if you create a new product, the Index Module will ingest it into its data store.
### Enable Index Module Feature Flag
Since the Index Module is still experimental, the `/store/products` and `/admin/products` API routes will use the Index Module to retrieve products only if the Index Module's feature flag is enabled. By enabling the feature flag, you can filter products by their linked data models in these API routes.