Search API Reference
This module enables searching within referenced content directly from a node, specifically designed for the Solr search backend. It is most useful for sites with complex content structures or access control rules that limit the visibility of referenced items, as it goes beyond the standard functionality of Search API fields.
Search Api Reference provides advanced search mechanics for Searching Referenced Content from within a node. This modules a index Processors for Search API.
Search API Reference ONLY supports the Solr backend at this time! If you are looking to use this module with other backend, I would be willing to see the work required to support it or accept a patch. This module achieves the desired functionality by using features that are available for Solr, and may not be easily supported by other backends.
When do I use this module?
Its important to understand that this module has a few use cases but should not me leveraged for most sites. Most of the basic functionality that can be achieved using this module can also be solved by features that are already in Search Api's core functionality.
If you are looking to implement simple references, use fields. The field configuration in Search API solves most use cases. You are able to load and search within referenced content using fields. For example, this module is not needed if you want to be able to search for content by taxonomy terms.
Whats it for then?
This module was built around the specific use case of searching within referenced content that may be limited via access control. On a site leveraging a module such as Paragraphs Access which could limit the visibility of referenced content to some users, you can't simply achieve this using the basic Search API Fields, since the referenced content needs to be limited. This also allows for building of complex site structures with nested referenced content and the ability to search within those items as well.
In the case above the complex access rules are added via the processor plugin available with the Advanced Access module, but the same function could be applied to nested nodes withing Paragraphs Access.
Support
For any questions about this modules features, bug reports, or feature requests please open an issue in the modules issue queue or contact the maintainer directly.