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

Merge pull request #197 from redis/document-non-zero-database-index-not-allowed

Browse source 
Updated documentation with note about indexing only being for database 0
This commit is contained in:
Simon Prickett 2022-04-07 10:35:38 +01:00 committed by GitHub
commit aa29547da6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -239,6 +239,8 @@ These queries -- and more! -- are possible because **Redis OM manages indexes fo
Querying with this index features a rich expression syntax inspired by the Django ORM, SQLAlchemy, and Peewee. We think you'll enjoy it! Querying with this index features a rich expression syntax inspired by the Django ORM, SQLAlchemy, and Peewee. We think you'll enjoy it!
**Note:** Indexing only works for data stored in Redis logical database 0. If you are using a different database number when connecting to Redis, you can expect the code to raise a `MigrationError` when you run the migrator.
### Embedded Models ### Embedded Models
Redis OM can store and query **nested models** like any document database, with the speed and power you get from Redis. Let's see how this works. Redis OM can store and query **nested models** like any document database, with the speed and power you get from Redis. Let's see how this works.

4
docs/connections.md
View file

@ -18,6 +18,8 @@ The default connection is equivalent to the following `REDIS_OM_URL` environment
redis://localhost:6379 redis://localhost:6379
**Note:** Indexing only works for data stored in Redis logical database 0. If you are using a different database number when connecting to Redis, you can expect the code to raise a `MigrationError` when you run the migrator.
### Passwords and Usernames ### Passwords and Usernames
Redis can be configured with password protection and a "default" user, in which case you might connect using only the password. Redis can be configured with password protection and a "default" user, in which case you might connect using only the password.
@ -34,6 +36,8 @@ If your Redis instance requires both a username and a password, you would includ
Redis databases are numbered, and the default is 0. You can leave off the database number to use the default database, or specify it. Redis databases are numbered, and the default is 0. You can leave off the database number to use the default database, or specify it.
**Note:** Indexing only works for data stored in Redis logical database 0. If you are using a different database number when connecting to Redis, you can expect the code to raise a `MigrationError` when you run the migrator.
### SSL Connections ### SSL Connections
Use the "rediss" prefix for SSL connections: Use the "rediss" prefix for SSL connections:

2
docs/getting_started.md
View file

@ -124,6 +124,8 @@ The default connection is equivalent to the following `REDIS_OM_URL` environment
**TIP:** Redis databases are numbered, and the default is 0. You can leave off the database number to use the default database. **TIP:** Redis databases are numbered, and the default is 0. You can leave off the database number to use the default database.
**Note:** Indexing only works for data stored in Redis logical database 0. If you are using a different database number when connecting to Redis, you can expect the code to raise a `MigrationError` when you run the migrator.
Other supported prefixes include "rediss" for SSL connections and "unix" for Unix domain sockets: Other supported prefixes include "rediss" for SSL connections and "unix" for Unix domain sockets:
rediss://[[username]:[password]]@localhost:6379/0 rediss://[[username]:[password]]@localhost:6379/0