Categorygithub.com/alash3al/srchx
repositorypackage
1.0.0-alpha
Repository: https://github.com/alash3al/srchx.git
Documentation: pkg.go.dev

# README

SRCHX

A standalone lightweight full-text search engine built on top of blevesearch and Go with multiple storage (scorch, boltdb, leveldb, rocksdb)

Features

  • Standanlone.
  • Light & Fast.
  • Utilizes the full CPU cores, thanks to Go runtime.
  • Pluggable storage engines.
  • Simple & Neat RESTful API.
  • Dynamic Index Creation, you don't need to create an index

Installation

  1. Goto Releases Page
  2. Choose your platform based version
  3. Download it
  4. Copy/Rename it as ./srchx
  5. Run chmod +x ./srchx
  6. Run ./srchx --help to see help info

Examples


# Example 1
# Add new document to the index "twitter" and type "tweet"
$ curl --request POST \
  --url 'http://localhost:2050/twitter/tweets/_doc/new' \
  --header 'Content-Type: application/json' \
  --data '{
	"user": "u5",
	"content": "this is my tweet",
	"views": 5
}'

# Example 2
# Fetch the previously added document using its ID
$ curl http://localhost:2050/twitter/tweets/_doc/2552b636-002e-4f1a-98b1-bdb06c2464ac

# Example 3
# Search for the documents that contains u5
$ curl http://localhost:2050/twitter/tweets/_search?query=+user:u5

API Documentation

I published the API docs on postman here with examples.