Expanding on the dsl mentions

This commit is contained in:
Honza Král
2015-11-02 15:35:36 +01:00
parent 8c79ec3dc2
commit 52eda45d8f
2 changed files with 17 additions and 5 deletions
+12 -4
View File
@@ -6,12 +6,20 @@ ground for all Elasticsearch-related code in Python; because of this it tries
to be opinion-free and very extendable.
For a more high level client library with more limited scope, have a look at
`elasticsearch-dsl`_ - it is a more pythonic library sitting on top of
``elasticsearch-py`` That contains a `query builder`_ and a `persistance
layer`_ that adds an ORM-like layer for convenience.
`elasticsearch-dsl`_ - a more pythonic library sitting on top of
``elasticsearch-py``.
It provides a more convenient and idiomatic way to write and manipulate
`queries`_. It stays close to the Elasticsearch JSON DSL, mirroring its
terminology and structure while exposing the whole range of the DSL from Python
either directly using defined classes or a queryset-like expressions.
It also provides an optional `persistence layer`_ for working with documents as
Python objects in an ORM-like fashion: defining mappings, retrieving and saving
documents, wrapping the document data in user-defined classes.
.. _elasticsearch-dsl: http://elasticsearch-dsl.rtfd.org/
.. _query builder: http://elasticsearch-dsl.readthedocs.org/en/latest/search_dsl.html
.. _queries: http://elasticsearch-dsl.readthedocs.org/en/latest/search_dsl.html
.. _persistance layer: http://elasticsearch-dsl.readthedocs.org/en/latest/persistence.html#doctype
Compatibility
+5 -1
View File
@@ -74,7 +74,11 @@ Features
This client was designed as very thin wrapper around Elasticseach's REST API to
allow for maximum flexibility. This means that there are no opinions in this
client; it also means that some of the APIs are a little cumbersome to use from
Python. We have created some :ref:`helpers` to help with this issue.
Python. We have created some :ref:`helpers` to help with this issue as well as
a more high level library (`elasticsearch-dsl`_) on top of this one to provide
a more convenient way of working with Elasticsearch.
.. _elasticsearch-dsl: http://elasticsearch-dsl.rtfd.org/
Persistent Connections
~~~~~~~~~~~~~~~~~~~~~~