django_haystack_opensearch

Getting Started

  • Installation
    • Prerequisites
    • Installation Methods
      • From PyPI with pip
      • From PyPI with uv
      • From PyPI with pipx
      • From Source
    • OpenSearch Plugins
      • Ingest Attachment Plugin
    • Configuration
    • Getting Help
  • Quickstart Guide
    • Prerequisites
    • Installation
    • Configuration
    • Creating Search Indexes
    • Indexing Your Data
    • Basic Search
    • Add Faceting
    • Next Steps
    • Getting Help

User Guide

  • Using django_haystack_opensearch
    • Basic Search
    • Filtering
      • Content Filtering
      • Facet Field Filtering
      • Other Filter Types
    • Faceting
      • Field Facets
      • Date Facets
      • Query Facets
      • Filtering by Facets
    • Highlighting
    • Spelling Suggestions
      • How it Works
    • More Like This
    • File Content Extraction
    • Spatial Search
      • Within a Bounding Box
      • Within a Distance
    • Sorting
    • Pagination
    • Model Filtering
    • Stored Fields
    • Boost
    • Advanced Usage
      • Combining Features
      • Using Multiple Connections
    • Indexing
      • Indexing Your Models
      • Programmatic Indexing
    • Understanding Facet Field Filtering
      • Why __exact is Required for Facet Fields
  • Configuration
    • OpenSearch Version Support
    • Django Haystack Settings
      • Required Settings
      • Optional Settings
      • Spelling Suggestions
      • Multiple Connections
    • Best Practices
      • Configuration Management
  • Frequently Asked Questions
    • General Questions
      • What is django_haystack_opensearch?
      • What versions of OpenSearch are supported?
    • Installation Issues
      • How do I install django_haystack_opensearch?
    • Usage Questions
      • Why do facet fields require __exact when filtering?
      • How do I index the contents of files (PDF, DOCX, etc.)?
      • How do I search across multiple models?
      • How do I get facet counts?
    • Troubleshooting
      • I’m getting no results when filtering on facet fields
      • Connection errors to OpenSearch
      • Index not found errors
    • Performance and Limitations
      • What are the performance characteristics?
      • Are there any limitations?
    • Migration from Elasticsearch
      • Can I migrate from an Elasticsearch backend?
    • Getting Help
      • Where can I get more help?
      • How do I report a bug?
  • Demo Application
    • Prerequisites
    • Setting Up the Demo
    • Accessing the Demo
    • Management Commands
      • import_play
      • rebuild_index
      • update_index
      • clear_index
    • Useful Commands
    • Exploring the Demo
    • Troubleshooting
      • Services won’t start
      • Can’t connect to OpenSearch
      • Database connection errors
      • Index is empty

Development

  • Contributing
    • Instructions for contributors
    • Setting up your development environment
    • Python Conventions for this project
    • Managing dependencies
    • Testing
    • Updating the documentation
      • doc/source/index.rst
      • doc/source/changelog.rst
      • autodoc
      • etc.
  • Python coding standards
    • Type hinting
    • Documentation
    • Structure
    • Linting

Reference

  • CHANGELOG
    • 1.0.0 (2026-01-16)
      • Enhancements
    • 0.1.1 (2026-01-07)
      • Bugfixes
    • 0.1.0 (2026-01-07)
      • Enhancements
  • The OpenSearch Backend
    • OpenSearchSearchBackend
      • OpenSearchSearchBackend.__init__
      • OpenSearchSearchBackend.build_schema
      • OpenSearchSearchBackend.build_search_kwargs
      • OpenSearchSearchBackend.clear
      • OpenSearchSearchBackend.extract_file_contents
      • OpenSearchSearchBackend.get_facet_fieldname
      • OpenSearchSearchBackend.more_like_this
      • OpenSearchSearchBackend.remove
      • OpenSearchSearchBackend.search
      • OpenSearchSearchBackend.setup
      • OpenSearchSearchBackend.update
      • OpenSearchSearchBackend.DEFAULT_FIELD_MAPPING
      • OpenSearchSearchBackend.DEFAULT_SETTINGS
      • OpenSearchSearchBackend.FIELD_MAPPINGS
      • OpenSearchSearchBackend.RESERVED_CHARACTERS
      • OpenSearchSearchBackend.RESERVED_WORDS
    • OpenSearchSearchEngine
      • OpenSearchSearchEngine.backend
      • OpenSearchSearchEngine.query
    • OpenSearchSearchQuery
      • OpenSearchSearchQuery.build_query_fragment
      • OpenSearchSearchQuery.matching_all_fragment
django_haystack_opensearch
  • Search

© Copyright California Institute of Technology.