// readme

Xapiand

A RESTful search and storage engine in one binary. Send it JSON or MessagePack documents over HTTP, then search them with full text, geospatial, and range queries. It runs on one machine.

๐Ÿ“– Official site: kronuz.github.io/Xapiand

๐Ÿ“ฆ Installation

docker run -p 8880:8880 --rm ghcr.io/kronuz/xapiand:latest      # Linux amd64 / arm64
brew install Kronuz/tap/xapiand && xapiand                     # macOS

Each release also ships RPM and DEB packages; see Installation, or build from source below.

๐Ÿš€ Quick start

curl -X PUT 'localhost:8880/twitter/tweet/1?commit' -H 'Content-Type: application/json' \
  -d '{"user": "Kronuz", "postDate": "2016-11-15T13:12:00", "message": "Trying out Xapiand"}'

curl localhost:8880/twitter/tweet/1                         # get it back
curl -X SEARCH 'localhost:8880/twitter/tweet/?q=user:Kronuz'  # search for it

The index is created on first write. Writes become searchable at the next commit, about a second later; ?commit waits for it. The Quick-start continues with searches,โ€ฆ