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

WIP on getting started guide

Browse source
This commit is contained in:
Andrew Brookins 2021-11-02 10:34:54 -07:00
parent 807a29b011
commit 8a5db647da
1 changed files with 45 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/getting_started.md
View file

@ -52,7 +52,6 @@ The easiest way to run these Redis modules during local development is to use th
You can quickly start Redis with the redismod Docker image by running the following command:
docker run -d -p 6379:6379 redislabs/redismod
**TIP:** The `-d` option runs Redis in the background.
For other installation methods, follow the "Quick Start" guides on both modules' home pages for alternative installation methods.
@ -68,7 +67,6 @@ The command you use to start Redis will depend on how you installed it.
If you installed Redis using `apt`, start it with the `systemctl` command:
sudo systemctl restart redis.service
Otherwise, you can start the server manually:
redis-server start
@ -94,11 +92,9 @@ The command to start Redis with Docker depends on the image you've chosen to use
You can install Redis OM with `pip` by running the following command:
pip install redis-om
Or, if you're using Poetry, you can install Redis OM with the following command:
poetry install redis-om
With Pipenv, the command is:
pipenv install redis-om
@ -114,18 +110,15 @@ However, if you configured Redis to run on a different port, or if you're using
The `REDIS_URL` environment variable follows the redis-py URL format:
redis://[[username]:[password]]@localhost:6379/[database number]
The default connection is eqivalent to the following `REDIS_URL` environment variable:
redis://@localhost:6379
**TIP:** Redis databases are numbered, and the default is 0. You can leave off the database number to use the default database.
Other supported prefixes include "rediss" for SSL connections and "unix" for Unix domain sockets:
rediss://[[username]:[password]]@localhost:6379/0
unix://[[username]:[password]]@/path/to/socket.sock?db=0
For more details about how to connect to Redis with Redis OM, see the [connections documentation](connections.md).
### Redis Cluster Support
@ -263,8 +256,29 @@ print(andrew.bio)
'Super Dope'
```
The model will then save this default value to Redis the next time you call `save()`.
### Automatic Primary Keys
Models generate a globally unique primary key automatically without needing to talk to Redis.
```python
print(andrew.pk)
'01FJM6PH661HCNNRC884H6K30C'
```
The ID is available *before* you save the model.
The default ID generation function creates [ULIDs](https://github.com/ulid/spec), though you can change the function that generates the primary key for models if you'd like to use a different kind of primary key.
## Saving Models
We can save the model to Redis by calling `save()`:
```python
andrew.save()
```
## Examining Your Data In Redis
## Validating Data
@ -274,5 +288,6 @@ print(andrew.bio)
Now that you know the basics of working with Redis OM, continue on for all the nitty-gritty details about [models and fields](validation.md).
<!-- Links -->
[redisearch-url]: https://oss.redis.com/redisearch/
[redis-json-url]: https://oss.redis.com/redisjson/