Working with attributes Leave feedback
Text attributes of documents are changed without the need to re-index documents in the search network.
To change document attributes, use the change_attributes method of the Indexer class. The changes are described by an AttributeChangeBatch object, in which documents are specified by their keys. The attributes are passed to the methods of the batch as a list of strings.
The asynchronous operation flag is available as an option (ChangeAttributesOptions.is_async). You can track the completion of the operation by subscribing to the attribute_changes_completed event.
The examples on this page use the master node of a running search network. The following code creates and starts the master node as described on the Search network deployment page; the slave nodes must be started beforehand. The examples that follow continue this code in the same Python process.
from groupdocs.search.common import FileLogger
from groupdocs.search.scaling import SearchNetworkNode
from groupdocs.search.scaling.configuring import Configuration, TcpSettings
base_path = "./SearchNetwork/"
base_port = 49100
# Loading the search network configuration from a file
configuration = Configuration.load(base_path + "Configuration.xml")
# Creating, configuring and starting the master node; the timeouts are specified in milliseconds
node = SearchNetworkNode.create_master_node(
0,
base_path + "Node0",
TcpSettings(base_port, 3000, 3000, 3000, 1000),
FileLogger(base_path + "Log.txt", 4.0),
configuration)
node.configure_all_nodes()
node.start()
The following sample file is used in this example: SearchNetwork/Configuration.xml
The following code example, which continues the previous one, demonstrates changing document attributes on the search network.
from groupdocs.search.common import AttributeChangeBatch
from groupdocs.search.options import ChangeAttributesOptions
document_key = "archive-catalogue.pdf" # The key of an indexed document
attribute = "important"
print("Adding attribute: " + attribute)
indexer = node.indexer
batch = AttributeChangeBatch()
batch.add(document_key, [attribute])
options = ChangeAttributesOptions()
indexer.change_attributes(batch, options)
To get all the attributes of a document, use the get_attributes method of the Indexer class. You must pass the document key as a parameter.
The following code example, which continues the code that creates the master node, demonstrates retrieving document attributes from the search network.
searcher = node.searcher
indexer = node.indexer
shard_indices = node.get_shard_indices()
print()
for shard_index in shard_indices:
infos = searcher.get_indexed_documents(shard_index)
for info in infos:
node_index = node.get_node_index(info.shard_index)
print("%d: %d: %s: %s" % (node_index, info.shard_index,
info.document_info.indexed_with_error, info.document_info.file_path))
attributes = indexer.get_attributes(info.document_info.file_path)
for attribute in attributes:
print("\t\t" + attribute)
More information about working with text attributes of documents can be found on the Document attributes page.
You may easily run the code from documentation articles and see the features in action in our GitHub examples:
Along with the full-featured Python 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.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
