Awesome
Manticore TypeScript client
❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-typescript/tree/4.0.0
Requirements
Minimum Manticore Search version is 4.2.1 with HTTP protocol enabled.
Manticore Search | manticoresearch-typescript | Node |
---|---|---|
dev | manticoresearch-ts-dev | >= 18.0.0 |
>= 6.2.0 | 4.0.x | >= 18.0.0 |
>= 6.2.0 | 3.3.1 | >= 18.0.0 |
>= 4.2.1 | >= 1.0.x | >= 18.0.0 |
Installation
npm install manticoresearch-ts
Getting Started
Please follow the installation instruction and execute the following typescript code:
import * as Manticoresearch from "manticoresearch-ts";
(async () => {
try {
const serverConfig = new Manticoresearch.ServerConfiguration("http://localhost:9308", {})
const config = Manticoresearch.createConfiguration({
baseServer: serverConfig,
});
indexApi = new Manticoresearch.IndexApi(config);
searchApi = new Manticoresearch.SearchApi(config);
# Perform insert and search operations
await indexApi.insert({"index": "products", "doc" : {"title" : "Crossbody Bag with Tassel", "price" : 19.85}});
await indexApi.insert({"index": "products", "doc" : {"title" : "microfiber sheet set", "price" : 19.99}});
var search_query = new Manticoresearch.SearchQuery()
search_query.query_string = "@title bag"
var search_request = new Manticoresearch.SearchRequest()
search_request.index = "products"
search_request.query = search_query
var query_highlight = new Manticoresearch.Highlight()
query_highlight.fields = {"title":{}}
search_request.highlight = query_highlight
var search_response = await searchApi.search(search_request)
console.log("The response of SearchApi->search:\n")
console.log(search_response)
# Alternatively, you can pass all request arguments as JSON strings
search_response = await searchApi.search({"index": "products", "query": {"query_string": "@title bag"}, "highlight": {"fields": ["title"]}});
console.log("The response of SearchApi->search:\n")
console.log(search_response)
} catch (error) {
console.error("Error response:", JSON.stringify(error));
}
})();
Documentation
Full documentation on the API Endpoints and Models used is available in docs folder as listed below.
Manticore Search server documentation: https://manual.manticoresearch.com.
Documentation for API Endpoints
All URIs are relative to http://127.0.0.1:9308
Class | Method | HTTP request | Description |
---|
| Manticoresearch.IndexApi | bulk | POST /bulk | Bulk index operations |
| Manticoresearch.IndexApi | delete | POST /delete | Delete a document in an index |
| Manticoresearch.IndexApi | insert | POST /insert | Create a new document in an index |
| Manticoresearch.IndexApi | partialReplace | POST /{index}/_update/{id} | Partially replaces a document in an index |
| Manticoresearch.IndexApi | replace | POST /replace | Replace new document in an index |
| Manticoresearch.IndexApi | update | POST /update | Update a document in an index |
| Manticoresearch.SearchApi | percolate | POST /pq/{index}/search | Perform reverse search on a percolate index |
| Manticoresearch.SearchApi | search | POST /search | Performs a search on an index |
| Manticoresearch.UtilsApi | sql | POST /sql | Perform SQL requests |
Documentation for Authorization
All endpoints do not require authorization.