tmtt/redis-om-python
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

More tweaks

Browse source
This commit is contained in:
Andrew Brookins 2021-10-25 14:43:48 -07:00
parent 42592013ba
commit c6820ed7e4
1 changed files with 20 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -22,16 +22,13 @@
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [💡 Why Redis OM?](#-why-redis-om) - [💡 Why Redis OM?](#-why-redis-om)
- [Starting Redis](#starting-redis) - [📇 Modeling Your Data](#-modeling-your-data)
- [📇 Modeling your domain (and indexing it!)](#-modeling-your-domain-and-indexing-it) - [✓ Validating Data With Your Model](#-validating-data-with-your-model)
- [🔎 Querying](#-querying) - [🔎 Rich Queries and Embedded Models](#-rich-queries-and-embedded-models)
- [Why this is important](#why-this-is-important) - [💻 Installation](#installation)
- [📚 Documentation](#documentation)
- [⛏️ Troubleshooting](#troubleshooting)
- [So how do you get RediSearch and RedisJSON?](#so-how-do-you-get-redisearch-and-redisjson) - [So how do you get RediSearch and RedisJSON?](#so-how-do-you-get-redisearch-and-redisjson)
- [Why Redis OM?](#why)
- [Getting started](#getting-started)
- [Installation](#installation)
- [Documentation](#documentation)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing) - [Contributing](#contributing)
- [License](#license) - [License](#license)
@ -41,7 +38,7 @@
## 💡 Why Redis OM? ## 💡 Why Redis OM?
Redis OM provides high-level abstractions for using Redis in Python, making it easy to model and query your Redis domain objects. Redis OM provides high-level abstractions that make it easy to model and query data in Redis with modern Python applications.
This **preview** release contains the following features: This **preview** release contains the following features:
@ -49,13 +46,11 @@ This **preview** release contains the following features:
* Declarative secondary-index generation * Declarative secondary-index generation
* Fluent APIs for querying Redis * Fluent APIs for querying Redis
## 🏁 Getting started ## 📇 Modeling Your Data
### Object Mapping Redis OM contains powerful declarative models that give you data validation, serialization, and persistence to Redis.
With Redis OM, you get powerful data modeling, extensible data validation with [Pydantic](pydantic-url), and rich query expressions. Check out this example of modeling customer data with Redis OM. First, we create a `Customer` model:
Check out this example of how we'd model customer data with Redis OM. First, we create a `Customer` model:
```python ```python
import datetime import datetime
@ -77,8 +72,6 @@ class Customer(HashModel):
bio: Optional[str] bio: Optional[str]
``` ```
**NOTE**: Redis OM uses Python type annotations for data validation. See the _Data Validation_ section of this README for more details.
Now that we have a `Customer` model, let's use it to save customer data to Redis. Now that we have a `Customer` model, let's use it to save customer data to Redis.
First, we create a new `Customer` object: First, we create a new `Customer` object:
@ -116,13 +109,13 @@ other_andrew = Customer.get('01FJM6PH661HCNNRC884H6K30C')
Or, continue reading to see how Redis OM makes data validation a snap. Or, continue reading to see how Redis OM makes data validation a snap.
### Data Validation ## ✓ Validating Data With Your Model
Redis OM uses [Pydantic](pydantic-url) to validate data based on the type annotations you assign to fields in a model class. Redis OM uses [Pydantic](pydantic-url) to validate data based on the type annotations you assign to fields in a model class.
This validation ensures that fields like `first_name`, which the `Customer` model marked as a `str`, are always string. **But every Redis OM model is also a Pydantic model**, so you can use Pydantic validators like `EmailStr`, `Pattern`, and many more for complex validation! This validation ensures that fields like `first_name`, which the `Customer` model marked as a `str`, are always strings. **But every Redis OM model is also a Pydantic model**, so you can use Pydantic validators like `EmailStr`, `Pattern`, and many more for complex validations!
As an example, because we used the `EmailStr` validator, we'll get a validation error if we try to save a `Customer` with an invalid email address: For example, because we used the `EmailStr` type for the `email` field, we'll get a validation error if we try to save a `Customer` with an invalid email address:
```python ```python
Customer( Customer(
@ -135,7 +128,7 @@ Customer(
) )
``` ```
This code generates a validation error: This code generates the following validation error:
``` ```
Traceback: Traceback:
@ -144,16 +137,16 @@ This code generates a validation error:
value is not a valid email address (type=value_error.email) value is not a valid email address (type=value_error.email)
``` ```
What's great about this is **any existing Pydantic validator should work** as a drop-in type annotation with a Redis OM model. You can also write arbitrarily complex custom validations! **Any existing Pydantic validator should work** as a drop-in type annotation with a Redis OM model. You can also write arbitrarily complex custom validations!
To learn more, see the [documentation on data validation](docs/validation.md). To learn more, see the [documentation on data validation](docs/validation.md).
#### Rich Queries and Embedded Models ## 🔎 Rich Queries and Embedded Models
Data modeling, validation, and saving models to Redis all work regardless of how you run Redis. Data modeling, validation, and saving models to Redis all work regardless of how you run Redis.
Next, we'll show you the **rich query expressions** and **embedded models** Redis OM provides when the [RediSearch](redisearch-url) and [RedisJSON](redis-json-url) modules are installed in your Redis deployment. Next, we'll show you the **rich query expressions** and **embedded models** Redis OM provides when the [RediSearch](redisearch-url) and [RedisJSON](redis-json-url) modules are installed in your Redis deployment or you're using [Redis Enterprise](redis-enterprise-url).
**TIP**: *Wait, what's a Redis module?* If you aren't familiar with Redis modules, review the "RediSearch and RedisJSON" section of this README. **TIP**: *Wait, what's a Redis module?* If you aren't familiar with Redis modules, review the "RediSearch and RedisJSON" section of this README.
@ -264,11 +257,11 @@ If you run into trouble or have any questions, we're here to help!
First, check the [FAQ](docs/faq.md). If you don't find the answer there, First, check the [FAQ](docs/faq.md). If you don't find the answer there,
hit us up on the [Redis Discord Server](http://discord.gg/redis). hit us up on the [Redis Discord Server](http://discord.gg/redis).
## ✨ RediSearch and RedisJSON ## ✨ So How Do You Get RediSearch and RedisJSON?
Some advanced features of Redis OM rely on core features from two source available Redis modules: [RediSearch](redisearch-url) and [RedisJSON](redis-json-url). Some advanced features of Redis OM rely on core features from two source available Redis modules: [RediSearch](redisearch-url) and [RedisJSON](redis-json-url).
You can run these modules in your self-hosted Redis deployment, or you can use Redis Enterprise, which includes both modules. You can run these modules in your self-hosted Redis deployment, or you can use [Redis Enterprise](redis-enterprise-url), which includes both modules.
To learn more, read [our documentation](docs/redis_modules.md). To learn more, read [our documentation](docs/redis_modules.md).
@ -303,4 +296,5 @@ Redis OM uses the [BSD 3-Clause license][license-url].
[redis-json-url]: https://oss.redis.com/redisjson/ [redis-json-url]: https://oss.redis.com/redisjson/
[pydantic-url]: https://github.com/samuelcolvin/pydantic [pydantic-url]: https://github.com/samuelcolvin/pydantic
[ulid-url]: https://github.com/ulid/spec [ulid-url]: https://github.com/ulid/spec
[redis-enterprise-url]: https://redis.com/try-free/