Welcome to esorm’s documentation!

Contents

• Introduction
  • ☰ Table of Contents
  • 💾 Installation
  • 🚀 Features
    • Supported ElasticSearch versions
    • Supported Python versions
  • 📖 Usage
    • Define a model
    • Aliases
    • Connecting to ElasticSearch
    • Create index templates
    • Create indices and mappings
    • Model instances
    • CRUD: Create
    • CRUD: Read
    • CRUD: Update
    • CRUD: Delete
    • Bulk operations
    • Search
    • Aggregations
    • Pagination and sorting
  • 🧪 Testing
  • 🛡 License
  • 📃 Citation
• Advanced Usage
  • Optimistic concurrency control
    • Retry on conflict
  • Lazy properties
  • Shard routing
  • Retreive Selected Fields Only
  • Watchers
  • FastAPI integration
    • FastAPI pagination
• Reference
  • Module contents
  • Submodules
    • esorm.aggs module
    • esorm.bulk module
    • esorm.error module
    • esorm.esorm module
    • esorm.fastapi module
    • esorm.fields module
    • esorm.logger module
    • esorm.model module
    • esorm.query module
    • esorm.response module
    • esorm.utils module
    • esorm.watcher module
• Changelog
  • v0.6.0
  • v0.5.2
  • v0.5.1
  • v0.5.0
  • v0.4.8
  • v0.4.7
  • v0.4.6
  • v0.4.5
  • v0.4.4
  • v0.4.3
  • v0.4.2
  • v0.4.1
  • v0.4.0
  • v0.3.2
  • v0.3.1
  • v0.3.0
  • v0.2.1
  • v0.2.0
  • v0.1.2
  • v0.1.1

Indices and tables

• Index

• Module Index

• Search Page