Table of Contents - algoliasearch-rails-2.1.4 Documentation
Pages
- CHANGELOG
- LICENSE
-
README
- API Documentation
- Setup
- Install
- Configuration
- Timeouts
- Notes
- Usage
- Index Schema
- Relevancy
- Indexing
- Frontend Search (realtime experience)
- Backend Search
- Backend Pagination
- Tags
- Faceting
- Faceted search
- Group by
- Geo-Search
- Options
- Auto-indexing & asynchronism
- Temporary disable auto-indexing
- Queues & background jobs
- Things to Consider
- With Sidekiq
- With DelayedJob
- Synchronism & testing
- Custom index name
- Per-environment indices
- Custom attribute definition
- Nested objects/relations
- Defining the relationship
- Propagating the change from a nested child
- With ActiveRecord
- With Sequel
- Custom
objectID
- Restrict indexing to a subset of your data
- Sanitizer
- UTF-8 Encoding
- Exceptions
- Configuration example
- Indices
- Manual indexing
- Manual removal
- Reindexing
- Atomical reindexing
- Regular reindexing
- Clearing an index
- Using the underlying index
- Primary/replica
- Share a single index
- Target multiple indices
- Testing
- Notes
- ❓ Troubleshooting
- Use the Dockerfile
- algoliasearch.rake
Classes and Modules
- AlgoliaSearch
- AlgoliaSearch::AlgoliaJob
- AlgoliaSearch::BadConfiguration
- AlgoliaSearch::ClassMethods
- AlgoliaSearch::ClassMethods::AdditionalMethods
- AlgoliaSearch::ClassMethods::AdditionalMethods::base
- AlgoliaSearch::ClassMethods::base
- AlgoliaSearch::Configuration
- AlgoliaSearch::Engine
- AlgoliaSearch::IndexSettings
- AlgoliaSearch::InstanceMethods
- AlgoliaSearch::MixedSlavesAndReplicas
- AlgoliaSearch::NoBlockGiven
- AlgoliaSearch::NotConfigured
- AlgoliaSearch::Pagination
- AlgoliaSearch::Pagination::Kaminari
- AlgoliaSearch::Pagination::WillPaginate
- AlgoliaSearch::Railtie
- AlgoliaSearch::SafeIndex
- AlgoliaSearch::Utilities
Methods
- ::clear_all_indexes — AlgoliaSearch::Utilities
- ::create — AlgoliaSearch::Pagination::Kaminari
- ::create — AlgoliaSearch::Pagination::WillPaginate
- ::create — AlgoliaSearch::Pagination
- ::extended — AlgoliaSearch::ClassMethods
- ::extended — AlgoliaSearch::ClassMethods::AdditionalMethods
- ::get_model_classes — AlgoliaSearch::Utilities
- ::included — AlgoliaSearch
- ::included — AlgoliaSearch::InstanceMethods
- ::log_or_throw — AlgoliaSearch::SafeIndex
- ::move_index — AlgoliaSearch::SafeIndex
- ::new — AlgoliaSearch::IndexSettings
- ::new — AlgoliaSearch::SafeIndex
- ::new — AlgoliaSearch::Pagination::Kaminari
- ::reindex_all_models — AlgoliaSearch::Utilities
- ::set_settings_all_models — AlgoliaSearch::Utilities
- #add_attribute — AlgoliaSearch::IndexSettings
- #add_attributes — AlgoliaSearch::IndexSettings
- #add_index — AlgoliaSearch::IndexSettings
- #add_replica — AlgoliaSearch::IndexSettings
- #additional_indexes — AlgoliaSearch::IndexSettings
- #algolia_attribute_changed? — AlgoliaSearch::ClassMethods
- #algolia_clear_index! — AlgoliaSearch::ClassMethods
- #algolia_conditional_index? — AlgoliaSearch::ClassMethods
- #algolia_configurations — AlgoliaSearch::ClassMethods
- #algolia_constraint_passes? — AlgoliaSearch::ClassMethods
- #algolia_enqueue_index! — AlgoliaSearch::InstanceMethods
- #algolia_enqueue_remove_from_index! — AlgoliaSearch::InstanceMethods
- #algolia_ensure_init — AlgoliaSearch::ClassMethods
- #algolia_facets — AlgoliaSearch::ClassMethods::AdditionalMethods
- #algolia_find_in_batches — AlgoliaSearch::ClassMethods
- #algolia_full_const_get — AlgoliaSearch::ClassMethods
- #algolia_index — AlgoliaSearch::ClassMethods
- #algolia_index! — AlgoliaSearch::ClassMethods
- #algolia_index! — AlgoliaSearch::InstanceMethods
- #algolia_index_name — AlgoliaSearch::ClassMethods
- #algolia_index_objects — AlgoliaSearch::ClassMethods
- #algolia_indexable? — AlgoliaSearch::ClassMethods
- #algolia_indexing_disabled? — AlgoliaSearch::ClassMethods
- #algolia_init_raw_answer — AlgoliaSearch::ClassMethods::AdditionalMethods
- #algolia_mark_for_auto_indexing — AlgoliaSearch::InstanceMethods
- #algolia_mark_must_reindex — AlgoliaSearch::InstanceMethods
- #algolia_mark_synchronous — AlgoliaSearch::InstanceMethods
- #algolia_must_reindex? — AlgoliaSearch::ClassMethods
- #algolia_object_id_changed? — AlgoliaSearch::ClassMethods
- #algolia_object_id_method — AlgoliaSearch::ClassMethods
- #algolia_object_id_of — AlgoliaSearch::ClassMethods
- #algolia_perform_index_tasks — AlgoliaSearch::InstanceMethods
- #algolia_raw_answer — AlgoliaSearch::ClassMethods::AdditionalMethods
- #algolia_raw_search — AlgoliaSearch::ClassMethods
- #algolia_reindex — AlgoliaSearch::ClassMethods
- #algolia_reindex! — AlgoliaSearch::ClassMethods
- #algolia_remove_from_index! — AlgoliaSearch::ClassMethods
- #algolia_remove_from_index! — AlgoliaSearch::InstanceMethods
- #algolia_search — AlgoliaSearch::ClassMethods
- #algolia_search_facet — AlgoliaSearch::ClassMethods
- #algolia_search_for_facet_values — AlgoliaSearch::ClassMethods
- #algolia_set_settings — AlgoliaSearch::ClassMethods
- #algolia_synchronous? — AlgoliaSearch::InstanceMethods
- #algolia_without_auto_index — AlgoliaSearch::ClassMethods
- #algolia_without_auto_index_scope — AlgoliaSearch::ClassMethods
- #algolia_without_auto_index_scope= — AlgoliaSearch::ClassMethods
- #algoliasearch — AlgoliaSearch::ClassMethods
- #algoliasearch_settings_changed? — AlgoliaSearch::ClassMethods
- #attribute — AlgoliaSearch::IndexSettings
- #attributes — AlgoliaSearch::IndexSettings
- #attributes_to_hash — AlgoliaSearch::IndexSettings
- #automatic_changed_method? — AlgoliaSearch::ClassMethods
- #automatic_changed_method_deprecated? — AlgoliaSearch::ClassMethods
- #client — AlgoliaSearch::Configuration
- #configuration — AlgoliaSearch::Configuration
- #configuration= — AlgoliaSearch::Configuration
- #encode_attributes — AlgoliaSearch::IndexSettings
- #geoloc — AlgoliaSearch::IndexSettings
- #get_attribute_names — AlgoliaSearch::IndexSettings
- #get_attributes — AlgoliaSearch::IndexSettings
- #get_default_attributes — AlgoliaSearch::IndexSettings
- #get_setting — AlgoliaSearch::IndexSettings
- #get_settings — AlgoliaSearch::SafeIndex
- #initiliaze — AlgoliaSearch::Configuration
- #is_active_record? — AlgoliaSearch::IndexSettings
- #is_mongoid? — AlgoliaSearch::IndexSettings
- #is_sequel? — AlgoliaSearch::IndexSettings
- #limit — AlgoliaSearch::Pagination::Kaminari
- #offset — AlgoliaSearch::Pagination::Kaminari
- #perform — AlgoliaSearch::AlgoliaJob
- #sanitize_attributes — AlgoliaSearch::IndexSettings
- #setup_client — AlgoliaSearch::Configuration
- #tags — AlgoliaSearch::IndexSettings
- #to_settings — AlgoliaSearch::IndexSettings
- #use_serializer — AlgoliaSearch::IndexSettings
- #wait_task — AlgoliaSearch::SafeIndex