|
5 | 5 | [](https://pypi.org/project/pyneo4j-ogm/) |
6 | 6 | [](https://pypi.org/project/pyneo4j-ogm/) |
7 | 7 |
|
8 | | -`pyneo4j-ogm` is a asynchronous `Object-Graph-Mapper` for [`Neo4j 5+`](https://neo4j.com/docs/) and [`Python 3.10+`](https://www.python.org/). It is inspired by [`beanie`](https://github.com/roman-right/beanie) and build on top of proven technologies like [`Pydantic 1.10`](https://docs.pydantic.dev/1.10/) and the [`Neo4j Python Driver`](https://neo4j.com/docs/api/python-driver/current/index.html). It saves you from writing ever-repeating boilerplate queries and allows you to focus on the `stuff that actually matters`. It is designed to be simple and easy to use, but also flexible and powerful. |
| 8 | +`pyneo4j-ogm` is a asynchronous `Object-Graph-Mapper` for [`Neo4j 5+`](https://neo4j.com/docs/) and [`Python 3.10+`](https://www.python.org/). It is inspired by [`beanie`](https://github.com/roman-right/beanie) and build on top of proven technologies like [`Pydantic 1.10+`](https://docs.pydantic.dev/latest/) and the [`Neo4j Python Driver`](https://neo4j.com/docs/api/python-driver/current/index.html). It saves you from writing ever-repeating boilerplate queries and allows you to focus on the `stuff that actually matters`. It is designed to be simple and easy to use, but also flexible and powerful. |
9 | 9 |
|
10 | 10 | ## 📣 Upcoming features |
11 | 11 |
|
12 | 12 | What's planned for future releases. |
13 | 13 |
|
14 | | -- [ ] Support for `Pydantic V2` |
15 | | -- [ ] Bookmark support |
16 | 14 | - [ ] Migration CLI for migrating your pyneo4j-ogm models |
| 15 | +- [ ] Bookmark support |
17 | 16 |
|
18 | 17 | ## 🎯 Features <a name="features"></a> |
19 | 18 |
|
@@ -548,7 +547,7 @@ Filters for nested properties are also not supported, since they are stored as s |
548 | 547 |
|
549 | 548 | #### Indexes, constraints and properties <a name="indexes-constraints-and-properties"></a> |
550 | 549 |
|
551 | | -Since `pyneo4j-ogm` is built on top of `Pydantic`, all of the features provided by `Pydantic` are available to you. This includes defining `properties` on your models. For more information about these features, please refer to the [`Pydantic documentation`](https://pydantic-docs.helpmanual.io/usage/schema/#schema-customization). |
| 550 | +Since `pyneo4j-ogm` is built on top of `Pydantic`, all of the features provided by `Pydantic` are available to you. This includes defining `properties` on your models. For more information about these features, please refer to the [`Pydantic documentation`](https://docs.pydantic.dev/latest/concepts/json_schema/#schema-customization). |
552 | 551 |
|
553 | 552 | On the other hand, `indexes and constraints` are handled solely by `pyneo4j-ogm`. You can define indexes and constraints on your models by using the `WithOptions` method wrapped around the type of the property. You can pass the following arguments to the `WithOptions` method: |
554 | 553 |
|
@@ -1182,7 +1181,7 @@ Because most frontend applications use `camelCase` for their properties, the `ex |
1182 | 1181 |
|
1183 | 1182 | ##### Instance.export_model() <a name="instance-export-model"></a> |
1184 | 1183 |
|
1185 | | -Export the model instance to a dictionary containing standard python types. Since this method uses `pydantic.BaseModel.json()` internally, all arguments it accepts are also accepted by this method. |
| 1184 | +Export the model instance to a dictionary containing standard python types. Since this method uses `pydantic.BaseModel.model_dump_json()` internally, all arguments it accepts are also accepted by this method. |
1186 | 1185 |
|
1187 | 1186 | ```python |
1188 | 1187 | developer = await Developer( |
|
0 commit comments