You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,15 @@ What's planned for future releases.
15
15
-[ ] Bookmark support
16
16
-[ ] Migration CLI for migrating your pyneo4j-ogm models
17
17
18
+
## 🎯 Features <aname="features"></a>
19
+
20
+
-[x]**Simple and easy to use**: `pyneo4j-ogm` is designed to be simple and easy to use, while also providing a solid foundation for some more advanced use-cases.
21
+
-[x]**Flexible and powerful**: `pyneo4j-ogm` is flexible and powerful. It allows you to do all sorts of things with your data, from simple CRUD operations to complex queries.
22
+
-[x]**Fully asynchronous**: `pyneo4j-ogm` is fully asynchronous and uses the `Neo4j Python Driver` under the hood.
23
+
-[x]**Supports Neo4j 5+**: `pyneo4j-ogm` supports Neo4j 5+ and is tested against the latest version of Neo4j.
24
+
-[x]**Fully typed**: `pyneo4j-ogm` is fully typed out of the box.
25
+
-[x]**Powered by Pydantic**: `pyneo4j-ogm` is powered by `Pydantic` and uses it's powerful validation and serialization features under the hood.
26
+
18
27
## 📦 Installation <aname="installation"></a>
19
28
20
29
Using [`pip`](https://pip.pypa.io/en/stable/):
@@ -29,15 +38,6 @@ or when using [`Poetry`](https://python-poetry.org/):
29
38
poetry add pyneo4j-ogm
30
39
```
31
40
32
-
## 🎯 Features <aname="features"></a>
33
-
34
-
-[x]**Simple and easy to use**: `pyneo4j-ogm` is designed to be simple and easy to use, while also providing a solid foundation for some more advanced use-cases.
35
-
-[x]**Flexible and powerful**: `pyneo4j-ogm` is flexible and powerful. It allows you to do all sorts of things with your data, from simple CRUD operations to complex queries.
36
-
-[x]**Fully asynchronous**: `pyneo4j-ogm` is fully asynchronous and uses the `Neo4j Python Driver` under the hood.
37
-
-[x]**Supports Neo4j 5+**: `pyneo4j-ogm` supports Neo4j 5+ and is tested against the latest version of Neo4j.
38
-
-[x]**Fully typed**: `pyneo4j-ogm` is fully typed out of the box.
39
-
-[x]**Powered by Pydantic**: `pyneo4j-ogm` is powered by `Pydantic` and uses it's powerful validation and serialization features under the hood.
40
-
41
41
## 🚀 Quickstart <aname="quickstart"></a>
42
42
43
43
Before we can jump right in, we have to take care of some things:
@@ -276,8 +276,8 @@ In the following we are going to take a closer look at the different parts of `p
You can pass filters using the `filters` argument to filter the returned nodes. For more about filters, see the [`Filtering queries`](#query-filters) section.
`Projections` can be used to only return specific parts of the models as dictionaries. For more information about projections, see the [`Projections`](#query-projections) section.
`Query options` can be used to define how results are returned from the query. They are provided via the `options` argument. For more about query options, see the [`Query options`](#query-options) section.
The `auto_fetch_nodes` and `auto_fetch_models` parameters can be used to automatically fetch all or selected nodes from defined relationship-properties when running the `find_many()` query. For more about auto-fetching, see [`Auto-fetching relationship-properties`](#query-auto-fetching).
1507
1507
@@ -1776,7 +1776,7 @@ Projections can help you to reduce bandwidth usage and speed up queries, since y
1776
1776
1777
1777
> **Note:** Only top-level mapping is supported. This means that you can not map properties to a nested dictionary key.
1778
1778
1779
-
In the following example, we will return a dictionary with a `dev_name` key, which get's mapped to the models `name` property and a `dev_age` key, which get's mapped to the models `age` property. Any defined mapping which does not exist on the model will have `None` as it's value
1779
+
In the following example, we will return a dictionary with a `dev_name` key, which get's mapped to the models `name` property and a `dev_age` key, which get's mapped to the models `age` property. Any defined mapping which does not exist on the model will have `None` as it's value. You can also map the result's `elementId` and `Id` using either `$elementId` or `$id` as the value for the mapped key.
0 commit comments