Document renaming Leave feedback

Sometimes a situation arises when an indexed document is renamed, but its contents have not changed. In this case, to save computing resources, you can notify the index about the renaming of the document, and then the document will not be reindexed during the update operation.

To notify an index about renaming a document, the notify method is used with a notification object created by the Notification.create_rename_notification method as a parameter. The notify method returns True if the notification was successfully performed.

You should keep in mind that if an index is notified of the renaming of a document, it will not be reindexed the next time you call the update method, even if its contents have changed. The following example demonstrates how to notify an index of a renamed document.

import os

from groupdocs.search import Index
from groupdocs.search.common import Notification

# Creating an index
index = Index("./index")

# Indexing documents in a document folder
index.add("./documents")

# Renaming a document
old_document_path = "./documents/OldDocumentName.txt"
new_document_path = "./documents/NewDocumentName.txt"
os.rename(old_document_path, new_document_path)

# Notifying the index about renaming
notification = Notification.create_rename_notification(old_document_path, new_document_path)
result = index.notify(notification)
print("Notification applied:", result)

# Updating the index
# The renamed document will not be reindexed
index.update()

for document in index.get_indexed_documents():
    print("Indexed:", os.path.basename(document.file_path))

# Restoring the original file name, so that the example can run again
os.rename(new_document_path, old_document_path)

Notification applied: True
Indexed: Newton.txt
Indexed: NewDocumentName.txt

You may find more code examples in our GitHub repository:

• GroupDocs.Search for Python via .NET examples

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.