Repository files navigation

Work in progress. Upstream at:https://github.com/rmind/nxsearch

nxsearch is a full-text search engine library which is also providedwith a web server integration.

The engine is written in C11 and is distributed under the 2-clause BSD license.

• Lightweight, simple and fast.
• BM25andTF-IDF algorithms.
• Integrates with theSnowball stemmer.
• Supports fuzzy matching (using the BK-tree with Levenshtein distance).
• Supports query logic operators, grouping, nesting, etc.
• Supports filters in Lua for easy extendibility.
• Basic UTF-8 and internationalization support.

To try as a web service:

# git submodule update --init --recursive  # ensure you have submodulesdocker-compose up app# spin up the serviceopen http://127.0.0.1:8000/docs# documentation page

TheNXS_BASEDIR environment variable specifies the base directory wherethe indexed documents as well as the application data files are stored.

# Create the index:curl -XPOST http://127.0.0.1:8000/test-idx# Index some test documents:curl -d"cat dog cow" http://127.0.0.1:8000/test-idx/add/1curl -d"dog cow" http://127.0.0.1:8000/test-idx/add/2curl -d"cat cat cat" http://127.0.0.1:8000/test-idx/add/3# Run a query:curl -s -d"cat" http://127.0.0.1:8000/test-idx/search| jq

• Swagger UI with the endpoint documentation is provided at/docs URL.

• The Lua filters API can be foundHERE.

• The C API documentation can be foundHERE.