Welcome to elasticmapper’s documentation!

elasticmapper is a ElasticSearch mapper for three ORMs - SQLAlchemy, Peewee, DjangoORM.

Allows you to easily generate ElasticSearch mappings based on models.

Installation

pip install elasticmapper

Contents

• Basic usage
  • Peewee example
  • SQLAlchemy example
  • DjangoORM example
• Mapper
  • elasticmapper.Mapper params
    • model : Union[django.models.Model, peewee.Model, sqlalchemy.declarative_base()]
    • keyword_fields : Iterable[str]
    • include : Iterable[str]
    • exclude : Iterable[str]
    • alternative_names : Dict[str, str]
    • follow_nested : bool
    • custom_values : Dict[str, dict]