📕

C# .NET API with linked class library v3.3

This is the API for usage with the self-hosted class library.

Version 3.3. See older versions below

Older versions
dotnet add package IndxSearchLib
💡

indxSearchLibs does not have any third party dependencies except Microsoft .NET. Current version is 8.

💻
Typical use case

🚀 Create an instance of the system

⛓ Insert with an array of documents

🪄 Create Index

🟢 Check ready status

🔎 Search

⛓ Insert one or more documents without re-indexing

🗑 Delete one or more documents without re-indexing

🪄 (re-index if system status says it is required)

All of these functions can be run multiple times. For example to perform incremental loading.

All variations of this pattern can be run continuously over a long period of time to assure that the index and data is up to date.

API

🎛️
Interfaces
⌨️ IIndxSearchEngine
📡
Classes
⚙️ IndxSearchEngine (constructor)
📄 Document
🔎 SearchQuery
🔑 KeyFilter
🎯 CoverageSetup (✨New✨)
💬 WordFilter
🔦 SearchResult
📃 SearchRecord
🟢 SystemStatus
🧵 StringReplacer (DEPRECATED)
🌀 TokenizerSetup

General All methods are thread-safe. All methods block except IndexAsync. A search will always run on the thread and the logic CPU it is called from.

Exception handling

If an exception occurs, this will be written to the log. Furthermore, the exception will then be raised to the client. If this happens, the stack trace will be obfuscated. Send us this and we'll have tools to de-obfuscate. In such a case, it is also an advantage that we see the search text and also the data set in which the search is made.