giza_sphinxsearch v0.1.2 API Reference

Modules

Giza Sphinx Search client. The Giza core class provides wrapping to make using Sphinx easy in the typical infrastructure of an elixir application. Any Giza functionality is easiest to use when started by piping a request starting here. All functionality is available through Giza.Query, Giza.Request etc.. this module aims to be agnostic of the query type (native, sphinxQL, http, real-time) and may become a protocol at some point

Supervisor for using Giza in an OTP application. Supervises the Giza worker and Maria SQL client for SphinxQL

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

Query building helper functions for native sphinx protocol query against searchd. Add customizations such as limits and phrase weighting to your queries. This module may be renamed and slightly refactored now that SphinxQL and API are supported

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

The Giza genserver worker. Handles result calling that can be supervised and handled upon any issue or crash. This should be the main interface against which querying is done if choosing to start a worker

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. All Sphinx functionality is accessable through this method