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 the 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 MaxSearchReportCount property of the IndexSettings class. The default value is 10. The value can be changed at any time. Learn more about index settings on the page Search index settings.

Each search report is represented by an instance of the SearchReport class, which contains the following information:

• StartTime - the start time of the search;
• EndTime - the end time of the search;
• SearchDuration - the search duration;
• DocumentCount - the number of documents found;
• OccurrenceCount - the total number of occurrences found;
• TextQuery - the search query in text form, or null if the search was performed with a query in object form;
• ObjectQuery - the search query in object form, or null if the search was performed with a query in text form;
• SearchOptions - the search options.

The ToString method returns the search query in text form for both kinds of queries.

The following example demonstrates how to get search reports from an index.

C#

string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
 
// Creating an index in the specified folder
Index index = new Index(indexFolder);
 
// Indexing documents from the specified folder
index.Add(documentsFolder);
 
// Searching in index
SearchResult result1 = index.Search("Einstein");
SearchResult result2 = index.Search("\"Theory of Relativity\"");
 
// Getting search reports
SearchReport[] reports = index.GetSearchReports();
 
// Printing reports to the console
foreach (SearchReport report in reports)
{
    Console.WriteLine("Query: " + report.ToString());
    Console.WriteLine("Time: " + report.StartTime);
    Console.WriteLine("Duration: " + report.SearchDuration);
    Console.WriteLine("Documents: " + report.DocumentCount);
    Console.WriteLine("Occurrences: " + report.OccurrenceCount);
    Console.WriteLine();
}

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.