Each time you perform a search in an index, a report is generated for that search. An array of search reports can be obtained by calling getSearchReports method of the Index class. Reports are stored in the index only while the index is loaded into RAM for use. If you reload the index, the reports will not be restored.
Each index search report contains the following information:
The start time of the search;
The end time of the search;
The search duration;
The number of documents found;
The total number of occurrences found;
The search query;
The search options.
The following example demonstrates how to get search reports from an index.
constindexFolder='c:/MyIndex/';constdocumentsFolder='c:/MyDocuments/';// Creating an index in the specified folder
constindex=newgroupdocs.search.Index(indexFolder);// Indexing documents from the specified folder
index.add(documentsFolder);// Searching in index
constquery1='water';constresult1=index.search(query1);constquery2='"Lorem ipsum"';constresult2=index.search(query2);// Getting search reports
constreports=index.getSearchReports();// Printing reports to the console
for(constreportofreports){console.log('Query: '+report.getTextQuery());console.log('Time: '+report.getStartTime());console.log('Duration: '+report.getSearchDuration());console.log('Documents: '+report.getDocumentCount());console.log('Occurrences: '+report.getOccurrenceCount());console.log();}
More resources
GitHub examples
You may easily run the code from documentation articles and see the features in action in our GitHub examples: