Table of Contents - meilisearch-rails-0.2.3 Documentation
Pages
- LICENSE
-
README
- Table of Contents <!– omit in toc –>
- 📖 Documentation
- 🤖 Compatibility with MeiliSearch
- 🔧 Installation
- Run MeiliSearch <!– omit in toc –>
- 🚀 Getting Started
- Configuration <!– omit in toc –>
- Add documents <!– omit in toc –>
- Basic Backend Search <!– omit in toc –>
- Backend Pagination <!– omit in toc –>
- Extra Configuration <!– omit in toc –>
- ⚙️ Settings
- 🔍 Custom search
- 🪛 Options
- MeiliSearch configuration & environment
- Custom index_uid
- Index UID according to the environment
- Index configuration
- Custom attribute definition
- Custom primary key
- Conditional indexing
- Target multiple indexes
- Share a single index
- Queues & background jobs
- Relations
- Sanitize attributes
- UTF-8 encoding
- Manual operations
- Indexing & deletion
- Access the underlying index object
- Development & testing
- Exceptions
- Testing
- Synchronous testing
- Disable auto-indexing & auto-removal
- ⚙️ Development workflow & contributing
- 👏 Credits
- meilisearch.rake
Classes and Modules
- MeiliSearch
- MeiliSearch::BadConfiguration
- MeiliSearch::ClassMethods
- MeiliSearch::ClassMethods::AdditionalMethods
- MeiliSearch::ClassMethods::AdditionalMethods::base
- MeiliSearch::ClassMethods::base
- MeiliSearch::Configuration
- MeiliSearch::Engine
- MeiliSearch::IndexSettings
- MeiliSearch::InstanceMethods
- MeiliSearch::MSJob
- MeiliSearch::NoBlockGiven
- MeiliSearch::NotConfigured
- MeiliSearch::Pagination
- MeiliSearch::Pagination::Kaminari
- MeiliSearch::Pagination::WillPaginate
- MeiliSearch::Railtie
- MeiliSearch::SafeIndex
- MeiliSearch::Utilities
Methods
- ::clear_all_indexes — MeiliSearch::Utilities
- ::create — MeiliSearch::Pagination::Kaminari
- ::create — MeiliSearch::Pagination::WillPaginate
- ::create — MeiliSearch::Pagination
- ::extended — MeiliSearch::ClassMethods
- ::extended — MeiliSearch::ClassMethods::AdditionalMethods
- ::get_model_classes — MeiliSearch::Utilities
- ::included — MeiliSearch
- ::included — MeiliSearch::InstanceMethods
- ::log_or_throw — MeiliSearch::SafeIndex
- ::new — MeiliSearch::IndexSettings
- ::new — MeiliSearch::SafeIndex
- ::new — MeiliSearch::Pagination::Kaminari
- ::reindex_all_models — MeiliSearch::Utilities
- ::set_settings_all_models — MeiliSearch::Utilities
- #add_attribute — MeiliSearch::IndexSettings
- #add_attributes — MeiliSearch::IndexSettings
- #add_index — MeiliSearch::IndexSettings
- #additional_indexes — MeiliSearch::IndexSettings
- #attribute — MeiliSearch::IndexSettings
- #attributes — MeiliSearch::IndexSettings
- #attributes_to_hash — MeiliSearch::IndexSettings
- #client — MeiliSearch::Configuration
- #configuration — MeiliSearch::Configuration
- #configuration= — MeiliSearch::Configuration
- #encode_attributes — MeiliSearch::IndexSettings
- #get_attribute_names — MeiliSearch::IndexSettings
- #get_attributes — MeiliSearch::IndexSettings
- #get_default_attributes — MeiliSearch::IndexSettings
- #get_setting — MeiliSearch::IndexSettings
- #is_active_record? — MeiliSearch::IndexSettings
- #is_mongoid? — MeiliSearch::IndexSettings
- #is_sequel? — MeiliSearch::IndexSettings
- #limit — MeiliSearch::Pagination::Kaminari
- #meilisearch — MeiliSearch::ClassMethods
- #meilisearch_settings_changed? — MeiliSearch::ClassMethods
- #ms_attribute_changed? — MeiliSearch::ClassMethods
- #ms_clear_index! — MeiliSearch::ClassMethods
- #ms_conditional_index? — MeiliSearch::ClassMethods
- #ms_configurations — MeiliSearch::ClassMethods
- #ms_constraint_passes? — MeiliSearch::ClassMethods
- #ms_enqueue_index! — MeiliSearch::InstanceMethods
- #ms_enqueue_remove_from_index! — MeiliSearch::InstanceMethods
- #ms_ensure_init — MeiliSearch::ClassMethods
- #ms_facets_distribution — MeiliSearch::ClassMethods::AdditionalMethods
- #ms_find_in_batches — MeiliSearch::ClassMethods
- #ms_full_const_get — MeiliSearch::ClassMethods
- #ms_index — MeiliSearch::ClassMethods
- #ms_index! — MeiliSearch::ClassMethods
- #ms_index! — MeiliSearch::InstanceMethods
- #ms_index_documents — MeiliSearch::ClassMethods
- #ms_index_uid — MeiliSearch::ClassMethods
- #ms_indexable? — MeiliSearch::ClassMethods
- #ms_indexing_disabled? — MeiliSearch::ClassMethods
- #ms_init_raw_answer — MeiliSearch::ClassMethods::AdditionalMethods
- #ms_mark_for_auto_indexing — MeiliSearch::InstanceMethods
- #ms_mark_must_reindex — MeiliSearch::InstanceMethods
- #ms_mark_synchronous — MeiliSearch::InstanceMethods
- #ms_must_reindex? — MeiliSearch::ClassMethods
- #ms_perform_index_tasks — MeiliSearch::InstanceMethods
- #ms_pk — MeiliSearch::ClassMethods
- #ms_primary_key_changed? — MeiliSearch::ClassMethods
- #ms_primary_key_method — MeiliSearch::ClassMethods
- #ms_primary_key_of — MeiliSearch::ClassMethods
- #ms_raw_answer — MeiliSearch::ClassMethods::AdditionalMethods
- #ms_raw_search — MeiliSearch::ClassMethods
- #ms_reindex! — MeiliSearch::ClassMethods
- #ms_remove_from_index! — MeiliSearch::ClassMethods
- #ms_remove_from_index! — MeiliSearch::InstanceMethods
- #ms_search — MeiliSearch::ClassMethods
- #ms_set_settings — MeiliSearch::ClassMethods
- #ms_synchronous? — MeiliSearch::InstanceMethods
- #ms_without_auto_index — MeiliSearch::ClassMethods
- #ms_without_auto_index_scope — MeiliSearch::ClassMethods
- #ms_without_auto_index_scope= — MeiliSearch::ClassMethods
- #offset — MeiliSearch::Pagination::Kaminari
- #perform — MeiliSearch::MSJob
- #sanitize_attributes — MeiliSearch::IndexSettings
- #settings — MeiliSearch::SafeIndex
- #to_settings — MeiliSearch::IndexSettings
- #use_serializer — MeiliSearch::IndexSettings
- #wait_for_pending_update — MeiliSearch::SafeIndex