Welcome to esorm’s documentation!

Contents

• Introduction
  • ☰ Table of Contents
  • 💾 Installation
  • 🚀 Features
    • Supported ElasticSearch versions
    • Supported OpenSearch versions
    • Supported Python versions
  • 📖 Usage
    • Define a model
    • 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
    • Iterating through all results (scan)
    • Raw search
  • 🖥 IDE support and type checking
    • Type checking of queries and aggregations
    • PyCharm
    • VS Code / Cursor
  • 🧪 Testing
  • 🛡 License
  • 📃 Citation
• Query Builder
  • Why a query builder
  • Quick start
  • Two ways to build a query: parameters and with blocks
    • Parameters
    • with blocks
    • Mixing them
  • How with blocks work
  • Combining queries with operators
  • Using the built query
  • Building queries dynamically
  • Query clauses
    • Compound queries
    • Term level queries
    • Full text queries
    • Joining queries
    • Geo queries
    • Vector queries
    • Any other query
    • Common parameters
  • Custom query clauses
  • Type checking
    • PyCharm
  • Tips and pitfalls
• Advanced Usage
  • Optimistic concurrency control
    • Retry on conflict
  • Lazy properties
  • Shard routing
  • Retrieve selected fields only
  • Iterating through large result sets
    • Basic usage
    • Parameters
    • How it works
    • Sorting
    • Stopping early
    • Keep alive and resources
    • Performance tips
    • OpenSearch
  • Watchers
  • FastAPI integration
    • FastAPI pagination
    • FastAPI streaming export
• Reference
  • Module contents
    • DenseVectorField()
    • ESBaseModel
    • ESBulk
    • ESModel
    • ESModelTimestamp
    • Field()
    • InvalidModelError
    • InvalidResponseError
    • NotFoundError
    • Pagination
    • Sort
    • connect()
    • get_es_version()
    • is_opensearch()
    • lazy_property()
    • retry_on_conflict()
    • setup_mappings()
  • Submodules
    • esorm.aggs module
    • esorm.builder module
    • esorm.bulk module
    • esorm.error module
    • esorm.esorm module
    • esorm.fastapi module
    • esorm.fields module
    • esorm.logger module
    • esorm.model module
    • esorm.opensearch module
    • esorm.query module
    • esorm.response module
    • esorm.utils module
    • esorm.watcher module
• Changelog
  • v0.8.1 — Raw search and API typing fixes
    • New feature
    • Fixes
  • v0.8.0 — OpenSearch support, query builder and async scanning
    • Compatibility changes
    • New features
    • Fixes and documentation
  • v0.7.0 - Breaking Change: Refresh Behavior Fixed
    • ⚠️ BREAKING CHANGE
    • Major Changes
    • Additional Improvements
  • v0.6.12: Subfields support
    • New Features
    • Breaking Changes
    • Bug Fixes
    • Documentation
    • Tests
  • v0.6.11
  • v0.6.10
  • v0.6.9
  • v0.6.8
  • v0.6.7
  • v0.6.6
  • v0.6.5
  • v0.6.4
  • v0.6.3
  • v0.6.2
  • v0.6.1
  • 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