https://github.com/manticoresoftware/go-sdk
Go client for Manticore Search
https://github.com/manticoresoftware/go-sdk
golang manticoresearch sdk sdk-go sphinxsearch
Last synced: about 1 year ago
JSON representation
Go client for Manticore Search
- Host: GitHub
- URL: https://github.com/manticoresoftware/go-sdk
- Owner: manticoresoftware
- License: apache-2.0
- Created: 2019-05-01T06:48:20.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-10T15:56:37.000Z (over 2 years ago)
- Last Synced: 2025-03-27T18:52:26.469Z (about 1 year ago)
- Topics: golang, manticoresearch, sdk, sdk-go, sphinxsearch
- Language: Go
- Homepage: https://manticoresearch.com/
- Size: 68.4 KB
- Stars: 53
- Watchers: 6
- Forks: 8
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Binary-API based Go SDK for [Manticore Search](https://www.manticoresearch.com).
❗❗❗ WARNING ❗❗❗
February 10th 2024:
**🚀We've released the new Manticore Go Client - https://github.com/manticoresoftware/manticoresearch-go . 🔃The SDK in this repository will no longer receive support. We recommend users switch to the new client for future updates and support.**
🔧Why the change? This Go SDK was hard to maintain due to its manual creation process and reliance on the Manticore binary protocol. While this method did offer insignificant speed benefits, it also made updates and maintenance more cumbersome. The new Go client marks a significant leap forward. By adopting auto-generation from the [OpenAPI specifications](https://manual.manticoresearch.com/Openapi#OpenAPI-specification), we ensure easier updates, consistent cross-SDK compatibility, and a stronger support moving forward. Transitioning away from a binary protocol may insignificantly impact performance, but the advantages of maintainability, simplified upgrades, and standard API practices significantly outweigh the drawbacks.
📣We urge all users to migrate to the new Go client. Designed for durability, ease of use, and seamless integration with Manticore's search capabilities, it's the future-proof choice. For migration support, visit our docs or contact us.
## Compatibility
The client is compatible with Manticore Search 2.8.2 and higher for majority of the commands.
It also may be used in many cases to access SphinxSearch daemon as well. However it's not guaranteed.
## Requirements
Go version 1.9 or higher
## Installation
```
go get github.com/manticoresoftware/go-sdk/manticore
```
## Usage
Here's a short example on how the client can be used:
Make sure there's some running Manticore instance, you can use our [docker image](https://hub.docker.com/r/manticoresearch/manticore) for a quick test:
```
docker run --name manticore -p 9313:9312 -p9306:9306 -d manticoresearch/manticore
```
Here's just a simplest script:
```
[root@srv ~]# cat manticore.go
package main
import "github.com/manticoresoftware/go-sdk/manticore"
import "fmt"
func main() {
cl := manticore.NewClient()
cl.SetServer("127.0.0.1", 9313)
cl.Open()
res, err := cl.Sphinxql(`replace into testrt values(1,'my subject', 'my content', 15)`)
fmt.Println(res, err)
res, err = cl.Sphinxql(`replace into testrt values(2,'another subject', 'more content', 15)`)
fmt.Println(res, err)
res, err = cl.Sphinxql(`replace into testrt values(5,'again subject', 'one more content', 10)`)
fmt.Println(res, err)
res2, err2 := cl.Query("more|another", "testrt")
fmt.Println(res2, err2)
}
```
And here's how it works:
```
[root@srv ~]# go run manticore.go
[Query OK, 1 rows affected]
[Query OK, 1 rows affected]
[Query OK, 1 rows affected]
Status: ok
Query time: 0s
Total: 1
Total found: 1
Schema:
Fields:
title
content
Attributes:
gid: int
Matches:
Doc: 2, Weight: 2, attrs: [15]
Word stats:
'more' (Docs:2, Hits:2)
'another' (Docs:1, Hits:1)
```
Read [full documentation on godoc](https://godoc.org/github.com/manticoresoftware/go-sdk/manticore) to learn more about available functions and find more examples. You can also read it from the console as `go doc go-sdk/manticore`