Algoliax
▼
Project version
v0.10.0
v0.9.1
v0.9.0
v0.8.3
v0.8.2
v0.8.1
v0.8.0
v0.7.1
v0.7.0
v0.6.0
v0.5.0
v0.4.3
v0.4.2
v0.4.1
v0.4.0
v0.3.0
v0.3.0-beta
v0.3.0-alpha
v0.2.0
Pages
Modules
API Reference
Modules
Changelog
v0.10.0 - 2025-03-10
v0.9.1 - 2024-12-12
v0.9.0 - 2024-11-26
v0.8.3 - 2024-10-18
v0.8.2 - 2024-09-16
v0.8.1 - 2024-09-11
v0.8.0 - 2024-09-11
v0.7.2 - 2023-09-18
v0.7.1 - 2022-03-29
v0.7.0 - 2022-03-29
v0.6.0 - 2021-06-10
v0.5.0 - 2021-03-04
v0.4.3 - 2020-08-31
v0.4.2 - 2020-05-14
v0.4.1 - 2020-05-01
v0.4.0 - 2020-04-24
v0.3.0 - 2020-04-04
v0.2.0 - 2020-01-27
License
Overview
Installation
Configuration
Usage
Configure index name at runtime
Copyright and License
Examples
Global index example
Generate a secured api key
Algoliax
Summary
Functions
generate_secured_api_key/2
generate_secured_api_key!/2
wait_task/1
with_user_ip/2
Algoliax.Indexer
Summary
Callbacks
build_object/1
build_object/2
configure_index/0
delete_by/1
delete_index/0
delete_object/1
get_object/1
get_object_id/1
get_settings/0
reindex/1
reindex/2
reindex_atomic/0
save_object/1
save_objects/2
search/2
search_facet/3
to_be_indexed?/1
Algoliax.Response
Summary
Types
t/0
Functions
new/2
Algoliax.Responses
Summary
Types
t/0
Algoliax.TemporaryIndexer
Summary
Functions
run/5
Exceptions
Algoliax.AlgoliaApiError
Algoliax.InvalidAlgoliaSettingsConfigurationError
Algoliax.InvalidAlgoliaSettingsFunctionError
Algoliax.InvalidApiKeyParamsError
Algoliax.InvalidReplicaConfigurationError
Algoliax.InvalidSynonymsSettingsConfigurationError
Algoliax.InvalidSynonymsSettingsFunctionError
Algoliax.MissingIndexNameError
Algoliax.MissingRepoError
Search documentation of Algoliax
Settings
Algoliax.InvalidSynonymsSettingsConfigurationError
exception
(Algoliax v0.10.0)
View Source
Raise when the
:synonyms
settings are not defined properly