Index Class - GroupDocs.Search for .NET

Index Class

Represents the main class for indexing documents and search through them.

Inheritance Hierarchy

SystemObject
GroupDocs.SearchIndex

Namespace: GroupDocs.Search
Assembly: GroupDocs.Search (in GroupDocs.Search.dll) Version: 21.3

Syntax

C++

public class Index : IDisposable

Public Class Index
	Implements IDisposable

public ref class Index : IDisposable

type Index =  
    class
        interface IDisposable
    end

The Index type exposes the following members.

Constructors

	Name	Description
	Index	Initializes a new instance of the Index class in memory.
	Index(String)	Initializes a new instance of the Index class. Creates a new or opens an existing index on disk.
	Index(IndexSettings)	Initializes a new instance of the Index class in memory with particular index settings.
	Index(String, IndexSettings)	Initializes a new instance of the Index class. Creates a new index with particular settings or opens an existing index on disk.
	Index(String, Boolean)	Initializes a new instance of the Index class. Loads an existing index from disk if overwriteIfExists is false; creates a new index on disk otherwise.
	Index(String, IndexSettings, Boolean)	Initializes a new instance of the Index class. Loads an existing index from disk if overwriteIfExists is false; creates a new index on disk with particular index settings otherwise.

Properties

	Name	Description
	Dictionaries	Gets the dictionary repository.
	Events	Gets the event hub for subscribing to events.
	IndexInfo	Gets the basic information on the index.
	IndexSettings	Gets the index setting.
	Repository	Gets the index repository object if the index is contained in it.

Methods

	Name	Description
	Add(String)	Performs indexing operation. Adds a file or folder by an absolute or relative path. Documents from all subfolders will be indexed.
	Add(String)	Performs indexing operation. Adds files or folders by an absolute or relative path. Documents from all subfolders will be indexed.
	Add(String, IndexingOptions)	Performs indexing operation. Adds a file or folder by an absolute or relative path. Documents from all subfolders will be indexed.
	Add(String, IndexingOptions)	Performs indexing operation. Adds files or folders by an absolute or relative path. Documents from all subfolders will be indexed.
	Add(Document, IndexingOptions)	Performs indexing operation. Adds documents from file system, stream, or structure.
	ChangeAttributes	Applies the specified batch of attribute changes to indexed documents without reindexing during the update operation.
	Delete(String, UpdateOptions)	Deletes indexed files or folders from the index. Then updates the index without deleted paths. Note that an individual document cannot be deleted from the index if it was added to the index as part of a folder.
	Delete(UpdateOptions, String)	Deletes documents indexed from streams or structures. Then updates the index without deleted documents.
	Dispose	Releases all resources used by the Index.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetAttributes	Gets all the attributes associated with the specified indexed document.
	GetDocumentText(DocumentInfo, OutputAdapter)	Generates HTML formatted text for indexed document and transfers it through the output adapter.
	GetDocumentText(DocumentInfo, OutputAdapter, TextOptions)	Generates HTML formatted text for indexed document and transfers it through the output adapter.
	GetHashCode	(Inherited from Object.)
	GetIndexedDocumentItems	Gets an array of nested items of the specified document (for container documents such as ZIP, OST, PST).
	GetIndexedDocuments	Gets an array of all indexed documents.
	GetIndexedPaths	Gets an array of indexed paths - documents or folders.
	GetIndexingReports	Gets the reports on indexing operations.
	GetSearchReports	Gets the reports on search operations.
	GetType	(Inherited from Object.)
	Highlight(FoundDocument, Highlighter)	Generates HTML formatted text with highlighted found terms.
	Highlight(FoundDocument, Highlighter, HighlightOptions)	Generates HTML formatted text with highlighted found terms.
	MemberwiseClone	(Inherited from Object.)
	Merge(Index, MergeOptions)	Merges the specified index into the current index. Note that the other index will not be changed.
	Merge(IndexRepository, MergeOptions)	Merges indexes from the specified index repository into the current index. Note that indexes in the repository will not be changed.
	Notify	Passes the specified notification object to the index to perform the notification.
	Optimize	Minimizes the number of index segments by merging them one with another. This operation improves search performance.
	Optimize(MergeOptions)	Minimizes the number of index segments by merging them one with another. This operation improves search performance.
	Search(String)	Searches in index.
	Search(SearchQuery)	Searches in index.
	Search(String, SearchOptions)	Searches in index.
	Search(SearchQuery, SearchOptions)	Searches in index.
	SearchNext(ChunkSearchToken)	Continues the chunk search started with method Search.
	SearchNext(ChunkSearchToken, Cancellation)	Continues the chunk search started with method Search.
	ToString	(Inherited from Object.)
	Update	Re-indexes documents that have been changed or deleted since last update. Adds new files that have been added to the indexed folders.
	Update(UpdateOptions)	Re-indexes documents that have been changed or deleted since last update. Adds new files that have been added to the indexed folders.

Remarks

Learn more

Examples

The example demonstrates a typical usage of the class.

string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchResult result = index.Search(query); // Searching in index

Reference

GroupDocs.Search Namespace