2021-11-24 16:18:03 +01:00
|
|
|
# Redis OM for Python
|
|
|
|
|
|
2021-11-25 03:12:27 +01:00
|
|
|
Welcome! This is the documentation for redis-om-python.
|
2021-11-24 16:18:03 +01:00
|
|
|
|
|
|
|
|
**NOTE**: The documentation is a bit sparse at the moment but will continue to grow!
|
|
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
|
|
Read the Getting Started tutorial at [getting_started.md](getting_started.md).
|
|
|
|
|
|
2021-11-24 16:42:06 +01:00
|
|
|
## Connecting to Redis
|
|
|
|
|
|
|
|
|
|
Read about connecting to Redis at [connections.md](connections.md).
|
|
|
|
|
|
2021-11-25 03:12:27 +01:00
|
|
|
## Models and Fields
|
|
|
|
|
|
|
|
|
|
Learn all about how to create model instances and define fields in [models.md](models.md).
|
|
|
|
|
|
2021-11-24 16:18:03 +01:00
|
|
|
## Validating Data
|
|
|
|
|
|
|
|
|
|
Read about how to use Redis OM models to validate data at [validation.md](validation.md)
|
|
|
|
|
|
|
|
|
|
## Redis Modules
|
|
|
|
|
|
|
|
|
|
Read how to get the RediSearch and RedisJSON modules at [redis_modules.md](redis_modules.md).
|
|
|
|
|
|
|
|
|
|
## FastAPI Integration
|
|
|
|
|
|
|
|
|
|
Redis OM is designed to integrate with the FastAPI web framework. See how this works at [fastapi_integration.md](fastapi_integration.md).
|
2021-11-27 00:26:52 +01:00
|
|
|
|
|
|
|
|
## Error Messages
|
|
|
|
|
|
|
|
|
|
Get help with (some of) the error messages you might see from Redis OM: [errors.md](errors.md)
|
