Search reports Leave feedback

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.

You can configure the maximum number of stored reports using the setMaxSearchReportCount method of the IndexSettings class. The default value is 10. Learn more about index settings on the page Search index settings.

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.

const indexFolder = 'c:/MyIndex/';
const documentsFolder = 'c:/MyDocuments/';

// Creating an index in the specified folder
const index = new groupdocs.search.Index(indexFolder);

// Indexing documents from the specified folder
index.add(documentsFolder);

// Searching in index
const query1 = 'water';
const result1 = index.search(query1);
const query2 = '"Lorem ipsum"';
const result2 = index.search(query2);

// Getting search reports
const reports = index.getSearchReports();

// Printing reports to the console
for (const report of reports) {
  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();
}

You may easily run the code from documentation articles and see the features in action in our GitHub examples:

• GroupDocs.Search for .NET examples

• GroupDocs.Search for Java examples

Along with full featured .NET library we provide simple, but powerful free Apps.

You are welcome to search over your PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX and more with our free online Free Online Document Search App.