API Reference giza_sphinxsearch v1.0.7

Client for Sphinx Search, the search product built by the legendary Andrew Aksyonoff. Sphinx is a robust and FAST database indexer and search daemon that can process large amounts of concurrent through-put. Giza aims to make implementing Sphinx in your Elixir apps quick and simple. Check out the examples below for most use cases and dive deeper if need be through the docs. The github docs take an Elixir perspective approach. This doc here will get you up and running with Sphinx and Elixir.

Query building helper functions for HTTP Sphinx API requests and responses. Add customizations such as limits and matches to a query. When Sphinx 3.x is released this library will become much more fleshed out; however in the meantime it should satisfy most production search needs.

The Giza genserver worker. Handles result calling that can be supervised and handled upon any issue or crash. Note that multiple workers would be needed for concurrency. Avoid using this service if your requests are already concurrent and you don't want to set up multiple service workers, as Sphinx can handle many concurrent requests and bottlenecks should be avoided.

Send query to Sphinx Daemon and return results syncronously using sphinx native protocol. Module could be removed/refactored soon.

Query building helper functions for SphinxQL requests (http://sphinxsearch.com/docs/devel.html#sphinxql-reference). This is the recommended way to query Sphinx (for client speed particularly) and will be the most supported style in Giza going forward. SphinxQL is very close to standard SQL with a few non-supported terms that wouldn't make sence in the search world and a few extras that only make sense in Sphinx's world. 100% of Sphinx' functionality is accessable through this method.

Query building helper functions for SphinxQL designed in commonly useful ways. Provides guidance when trying to take advantage of advanced search functionality without having to know every nuance of sphinx' query language.

Generate a Sphinx Search Config file. Uses database credentials + sensible defaults.

Append an index skeleton to your Sphinx Config. Very convenient!

Mix shortcut to running the Sphinx Indexer to build an index against the data source.

Mix shortcut to run a query directly against the locally running sphinx instance.

Mix shortcut to running the Sphinx Indexer to build an index against the data source