openedx.core.djangoapps.content.search.management.commands package

Submodules

openedx.core.djangoapps.content.search.management.commands.reindex_studio module

Command to queue incremental population of the Studio Meilisearch search index.

Index creation, configuration, and schema reconciliation are handled automatically via the post_migrate signal. This command is solely responsible for enqueuing the population task in Celery.

See also cms/djangoapps/contentstore/management/commands/reindex_course.py which indexes LMS (published) courses in ElasticSearch.

class openedx.core.djangoapps.content.search.management.commands.reindex_studio.Command(stdout=None, stderr=None, no_color=False, force_color=False)

Bases: BaseCommand

Add all course and library content to the Studio search index.

This enqueues a Celery task that incrementally indexes all courses and libraries. Progress is tracked via IncrementalIndexCompleted, so the task can safely resume if interrupted.

Index creation and configuration are handled by post_migrate reconciliation (runs automatically on ./manage.py cms migrate).

If it’s ever necessary to reset the incremental indexing state (force the full re-index process to start from the beginning), use:

./manage.py cms shell -c ‘IncrementalIndexCompleted.objects.all().delete()’

This will delete all the IncrementalIndexCompleted records and will help in restarting the index population.

add_arguments(parser)

Entry point for subclassed commands to add custom arguments.

handle(*args, **options)

The actual logic of the command. Subclasses must implement this method.

help = 'Add all course and library content to the Studio search index.'

Module contents