README
¶
Letarette - a modular full-text search system
Letarette provides full-text search capabilities to your project with very little setup. You can start out small with a single local index, and if you need, grow to a fully redundant installation with a sharded index.
There is a client library for Go as part of the Letarette main project and a separate Node.js library, letarette.js for easy integration.
Read more on the Letarette main site.
Building
Letarette uses the bygg build system, just run go generate in the project root to build.
Since Letarette uses cgo, gcc is required for building.
On MacOS and Linux, this is usually not an issue.
On Windows, Letarette builds using mingw from Chocolatey:
choco install mingw
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Revision = ""
Revision is set the the current git sha, or "dev"
var Tag = ""
Tag is set to the current git tag, or the current date
Functions ¶
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
auxiliary
Package auxiliary provides SQL functions "tokens", "gettokens" and "firstmatch"
|
Package auxiliary provides SQL functions "tokens", "gettokens" and "firstmatch" |
|
pkg
|
|
|
protocol
Package protocol describes the wire protocol between workers, document managers and search agents.
|
Package protocol describes the wire protocol between workers, document managers and search agents. |
|
spinner
Package spinner provides a simple progress spinner.
|
Package spinner provides a simple progress spinner. |