Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.55 KB

README.md

File metadata and controls

55 lines (39 loc) · 1.55 KB
Raw

FastDex

FastDex

Fast inverted index powered by Lucene.NET.

Getting Started

Install the library:

Install-Package FastDex

Create an index, by default file storage is used:

// creates directory "myindex" if it doesn't exist, rebuilds stale index if necessary
InvertedIndex index = new InvertedIndex("myindex");

Add some documents:

List<IndexDocument> sourceDocuments =
[
    new IndexDocument { Content = "public v[oi]d Method() ú", Id = "1" },
    new IndexDocument { Content = "int x = 5 * 3; ú", Id = "2" },
    new IndexDocument { Content = "if (condition) { }", Id = "3" },
];

/* removes any other documents currently indexed, updates the existing documents if content changed
   can report progress */
index.SynchronizeIndex(sourceDocuments);

Alternatively, add/update and delete documents manually:

index.IndexDocument("document content", "1"); // add/update
index.DeleteDocument("1");

Finally, search the index:

// supported features: case (in)sensitivity, whole words search, paging
List<SearchResult> results = index.Search("x =");

Gotchas

  • Dispose() the index once it's no longer needed.
  • The index can be searched from multiple threads simultaneously (near realtime).
  • The index can be opened only once, use it as a static resource and dispose of it when closing the application, eg. lifetime.ApplicationStopping.Register(() => { myindex.Dispose(); }); in .NET Core.