https://github.com/jchristn/indexengine

IndexEngine is a lightweight document and text indexing platform written in C#.
https://github.com/jchristn/indexengine

database index nuget search sqlite

Last synced: about 1 month ago
JSON representation

IndexEngine is a lightweight document and text indexing platform written in C#.

• Host: GitHub
• URL: https://github.com/jchristn/indexengine
• Owner: jchristn
• License: mit
• Created: 2016-06-28T00:29:07.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-01-07T16:13:34.000Z (about 3 years ago)
• Last Synced: 2024-05-02T02:13:43.287Z (9 months ago)
• Topics: database, index, nuget, search, sqlite
• Language: C#
• Homepage:
• Size: 46.1 MB
• Stars: 34
• Watchers: 5
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![alt tag](https://github.com/jchristn/indexengine/blob/master/assets/icon.png)

# IndexEngine

[![NuGet Version](https://img.shields.io/nuget/v/IndexEngine.svg?style=flat)](https://www.nuget.org/packages/IndexEngine/) [![NuGet](https://img.shields.io/nuget/dt/IndexEngine.svg)](https://www.nuget.org/packages/IndexEngine) 

IndexEngine is a lightweight document and text indexing platform written in C# targeted to both .NET Core and .NET Framework.  IndexEngine uses Sqlite as a storage repository for index data. 

IndexEngine does NOT provide storage of the original documents.

## New in v2.1.3

- .NET 5 support

- Migrate to ORM

## Help or feedback

First things first - do you need help or have feedback?  Contact me at joel dot christner at gmail dot com or file an issue here!

## Performance and scale

It's pretty quick :)  It hasn't been tested with large document libraries or large files, so I'd recommend testing thoroughly before using in production. 

## Simple Example

```csharp

using Indexer;

IndexEngine ie = new IndexEngine("idx.db");

// Add a document

Document d = new Document(

  "GUID",              // GUID supplied by the caller

  "Title",             // i.e. Mark Twain

  "Description",       // i.e. A Great Book

  "File Path or URL",  // i.e. C:\Documents\MarkTwain.txt

  "Source",            // i.e. The Internet

  "AddedBy",           // i.e. Joel

  Encoding.UTF8.GetBytes("This is some sample data for indexing")

);

await ie.AddAsync(d);  // async

ie.Add(d);             // sync

// Search the index

List terms = new List { "some", "data" };

List results = ie.Search(terms);

foreach (Document d in results) Console.WriteLine(d.ToString());

// Find document GUIDs where terms can be found

List guids = i.e.GetDocumentGuidsByTerms(terms);

foreach (string s in results) Console.WriteLine(s);

// List number of threads actively indexing documents

Console.WriteLine("Number of documents being indexed now: " + ie.CurrentIndexingThreads);

// Get the names of docs that are currently being indexed

IEnumerable activeDocs = ie.DocumentsIndexing();

// Delete documents from the index

ie.DeleteDocumentByGuid("abcd1234...");

ie.DeleteDocumentByHandle("C:\\Documents\\MarkTwain.txt");

// Retrieve documents

Document d = GetDocumentByGuid("abcd1234...");

Document d = GetDocumentByHandle("C:\\Documents\\MarkTwain.txt");

bool b = IsGuidIndexed("abcd1234...");

bool b = IsHandleIndexed("C:\\Documents\\MarkTwain.txt");

```