Skip to content

Commit 52eda45

Browse files
committed
Expanding on the dsl mentions
1 parent 8c79ec3 commit 52eda45

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

README

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,20 @@ ground for all Elasticsearch-related code in Python; because of this it tries
66
to be opinion-free and very extendable.
77

88
For a more high level client library with more limited scope, have a look at
9-
`elasticsearch-dsl`_ - it is a more pythonic library sitting on top of
10-
``elasticsearch-py`` That contains a `query builder`_ and a `persistance
11-
layer`_ that adds an ORM-like layer for convenience.
9+
`elasticsearch-dsl`_ - a more pythonic library sitting on top of
10+
``elasticsearch-py``.
11+
12+
It provides a more convenient and idiomatic way to write and manipulate
13+
`queries`_. It stays close to the Elasticsearch JSON DSL, mirroring its
14+
terminology and structure while exposing the whole range of the DSL from Python
15+
either directly using defined classes or a queryset-like expressions.
16+
17+
It also provides an optional `persistence layer`_ for working with documents as
18+
Python objects in an ORM-like fashion: defining mappings, retrieving and saving
19+
documents, wrapping the document data in user-defined classes.
1220

1321
.. _elasticsearch-dsl: http://elasticsearch-dsl.rtfd.org/
14-
.. _query builder: http://elasticsearch-dsl.readthedocs.org/en/latest/search_dsl.html
22+
.. _queries: http://elasticsearch-dsl.readthedocs.org/en/latest/search_dsl.html
1523
.. _persistance layer: http://elasticsearch-dsl.readthedocs.org/en/latest/persistence.html#doctype
1624

1725
Compatibility

docs/index.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,11 @@ Features
7474
This client was designed as very thin wrapper around Elasticseach's REST API to
7575
allow for maximum flexibility. This means that there are no opinions in this
7676
client; it also means that some of the APIs are a little cumbersome to use from
77-
Python. We have created some :ref:`helpers` to help with this issue.
77+
Python. We have created some :ref:`helpers` to help with this issue as well as
78+
a more high level library (`elasticsearch-dsl`_) on top of this one to provide
79+
a more convenient way of working with Elasticsearch.
80+
81+
.. _elasticsearch-dsl: http://elasticsearch-dsl.rtfd.org/
7882

7983
Persistent Connections
8084
~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)