Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For the courseware index example it matters whether this is on in the CMS settings, not the LMS settings, since indexing is tied into signals that happen during course publish.

edx-search Uses by Index

index name

what is it?

indexer

searcher

courseware_content

course content

CoursewareSearchIndexer in platform/cms

/search and perform_search in edx-search

library_index

library content, similar to courseware_content

LibrarySearchIndexer in platform/cms

LibraryToolsService in platform/xmodule

course_info

course about info, maybe this object

CourseAboutSearchIndexer in platform/cms

course_discovery_search and its endpoint in edx-search

content_library_index

library metadata

ContentLibraryIndexer in platform/core/content libraries app

the same indexer, via its parent class get function which is exposed via an API

content_library_block_index

library content

LibraryBlockIndexer in platform/core/content libraries app

the same indexer, via its parent class get function which is exposed via an API

course_team_index

team info but not members

CourseTeamIndexer in platform/lms teams app

Team list view in the same app

Course Content for Indices

The indexers which run over course content, CoursewareSearchIndexer and LibrarySearchIndexer, get the bulk of that content by calling index_dictionary provided by the xblock IndexInfoMixin. This allows xblocks to be completely flexible in their indexed content, at the price of scattering information about what that content is across all xblocks.

Best Indexer/Searcher Practices

...