Indexing reports

Indexing reports are created for indexing and updating operations. Indexing reports can be retrieved from the index using the get_indexing_reports method. 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 max_indexing_report_count property of the IndexSettings class. The default value is 5. Learn more about index settings on the page Search index settings.

Each indexing report (IndexingReport) contains the following information:

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

from groupdocs.search import Index

documents_folder1 = "./documents"
documents_folder2 = "./documents2"

# Creating an index in the specified folder
index = Index("./index")

# Indexing documents
index.add(documents_folder1)
index.add(documents_folder2)

# Getting indexing reports
reports = index.get_indexing_reports()

# Printing information from reports to the console
for report in reports:
    print("Time: " + str(report.start_time))
    print("Duration: " + str(report.indexing_time))
    print("Documents total: " + str(report.total_documents_in_index))
    print("Terms total: " + str(report.total_term_count))
    print("Indexed documents size (MB): " + str(report.indexed_documents_size))
    print("Index size (MB): " + str(report.total_index_size / 1024.0 / 1024.0))
    print("Segments: " + str(report.segment_count))
    print("Indexed documents: " + str(len(report.indexed_documents)))
    for error in report.errors:
        print("Error: " + error)
    print()

The following sample files are used in this example: documents/Einstein.txt, documents/Newton.txt

The following sample file is used in this example: documents2/Curie.txt

Time: 2026-10-29 19:05:39.198203+02:00
Duration: 0:00:00.135150
Documents total: 2
Terms total: 86
Indexed documents size (MB): 0.000308990478515625
Index size (MB): 2.0021800994873047
Segments: 1
Indexed documents: 2

Time: 2026-10-29 19:05:39.333857+02:00
[TRUNCATED]

Download full output

More resources

GitHub examples

You may find more code examples in our GitHub repository:

Free online document search App

Along with the full-featured library, we provide a free online document search app. You are welcome to search over your PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX and more with our Free Online Document Search App.

Close
Loading

Analyzing your prompt, please hold on...

An error occurred while retrieving the results. Please refresh the page and try again.