summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Update redismodules.rst (#2747)Cristian Matache2023-05-081-1/+1
| | | Co-authored-by: dvora-h <67596500+dvora-h@users.noreply.github.com>
* Updated AWS Elasticache IAM Connection Example (#2702)Nick Gerow2023-05-031-12/+44
| | | Co-authored-by: Nick Gerow <nick.gerow@enlightedinc.com>
* Fix topk list example. (#2724)AYMEN Mohammed2023-04-271-1/+1
|
* Improving Vector Similarity Search Example (#2661)Tyler Hutcherson2023-04-131-24/+586
| | | | | | | | | | | | | | | | | * update vss docs * add embeddings creation and storage examples * update based on feedback * fix version and link * include more realistic search examples and clean up indices * completely remove initial cap reference --------- Co-authored-by: Chayim <chayim@users.noreply.github.com>
* Update example of Redisearch creating index (#2703)mzdehbashi-github2023-04-131-1/+5
| | | When creating index, fields should be passed inside an iterable (e.g. list or tuple)
* ConnectionPool SSL example (#2605)CrimsonGlory2023-03-151-0/+21
|
* Fixed CredentialsProvider examples (#2587)Bar Shaul2023-03-151-20/+30
| | | Co-authored-by: dvora-h <67596500+dvora-h@users.noreply.github.com>
* Add TS.MGET example for OS Redis Cluster (#2507)Igor Malinovskiy2023-02-071-0/+41
|
* trivial typo fix (#2566)Rich Bowen2023-01-292-2/+2
| | | | | * trivial typo fix * trivial typo fix
* Add OpenTelemetry example with Uptrace backend (#2452)Vladimir Mihailenco2022-12-1418-2/+1248
| | | | | | | | | | | * chore: add opentelemetry example * chore: add opentelemetry API Jupyter notebook * chore: use a shorter title * chore: cleanup Co-authored-by: dvora-h <67596500+dvora-h@users.noreply.github.com>
* Switch docs to furo theme (#2492)Igor Malinovskiy2022-12-144-14/+53
| | | | | | | * Switch to docs to Furo theme * Add logo and year Co-authored-by: Igor Malinovskiy <igor.malinovskiy@redis.com>
* Use explicit index name in RediSearch example (#2466)Igor Malinovskiy2022-12-041-7/+9
| | | | Co-authored-by: Igor Malinovskiy <igor.malinovskiy@redis.com> Co-authored-by: Chayim I. Kirshen <c@kirshen.com>
* Adding connection step to bloom filter examples (#2478)Nermina Miller2022-11-301-10/+14
| | | | | | | * Fixes #2415, adds a connect step to bloom commands * Update redismodules.rst Apply feedback
* Removed bad tokens from connection_examples.ipynb to fix the json output (#2455)Bar Shaul2022-11-211-5/+0
|
* Retry documentation. (#2166) (#2456)Luca Cillario2022-11-213-2/+69
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Retry documentation. (#2166) * Fixed typo. * Update docs/retry.rst Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/retry.rst Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/retry.rst Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/retry.rst Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/retry.rst Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/retry.rst Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/retry.rst Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/retry.rst Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
* CredentialsProvider class added to support password rotation (#2261)Bar Shaul2022-11-102-54/+268
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * A CredentialsProvider class has been added to allow the user to add his own provider for password rotation * Moved CredentialsProvider to a separate file, added type hints * Changed username and password to properties * Added: StaticCredentialProvider, examples, tests Changed: CredentialsProvider to CredentialProvider Fixed: calling AUTH only with password * Changed private members' prefix to __ * fixed linters * fixed auth test * fixed credential test * Raise an error if username or password are passed along with credential_provider * fixing linters * fixing test * Changed dundered to single per side underscore * Changed Connection class members username and password to properties to enable backward compatibility with changing the members value on existing connection. * Reverting last commit and adding backward compatibility to 'username' and 'password' inside on_connect function * Refactored CredentialProvider class * Fixing tuple type to Tuple * Fixing optional string members in UsernamePasswordCredentialProvider * Fixed credential test * Added credential provider support to AsyncRedis * linters * linters * linters * linters - black Co-authored-by: dvora-h <67596500+dvora-h@users.noreply.github.com> Co-authored-by: dvora-h <dvora.heller@redis.com>
* Tidy up asyncio examples. (#2431)Sam Bull2022-10-301-41/+27
|
* doc: redismodules.rst fix (#2429)Ashik Shezan2022-10-251-1/+1
| | | | | Parentheses were not closed Co-authored-by: dvora-h <67596500+dvora-h@users.noreply.github.com>
* vecsim docs fix (#2402)Chayim2022-09-281-1/+1
|
* cleaning up the readme and moving docs into readthedocs (#2291)Chayim2022-07-274-0/+791
| | | | | * cleaning up the readme and moving docs into readthedocs * examples at the end as per pr comments
* Doc add timeseries example (#2267)Iglesys2022-07-252-0/+632
| | | | | | | | | | | | | * DOC add timeseries example * DOC add timeseries examples * Apply suggestions * Fix typo Detention period => Retention period Co-authored-by: Gauthier Imbert <gauthier@PC17>
* redis stream example (#2269)pedrofrazao2022-07-242-0/+755
| | | | | | | * redis stream example * redis stream example on docs/examples.rst Co-authored-by: pedro.frazao <perl.pf@netcf.org>
* DOC add pipeline examples (#2240)Iglesys2022-06-232-1/+310
| | | | | | | * DOC add pipeline examples * Add pipeline notebook to the example.rst file * retrigger checks
* Correct retention_msecs value (#2232)earthgecko2022-06-191-1/+1
| | | The `retention_msecs` takes a millisecond value not a seconds value, having checked and tested redis/commands/timeseries/commands.py is not adjusting seconds to milliseconds it is passing it through as is, therefore the statement in this doc is incorrect as it creates a time series with a retention period of 5 milliseconds not 5 seconds as stated.
* async_cluster: improve docs (#2208)Utkarsh Gupta2022-06-021-2/+5
| | | | - move response_callbacks kwarg inside __init__ to hide it from docs - use :member-order: bysource to group similar commands together
* async_cluster: add pipeline support (#2199)Utkarsh Gupta2022-05-301-0/+5
| | | Co-authored-by: dvora-h <67596500+dvora-h@users.noreply.github.com>
* Add Async RedisCluster (#2099)Utkarsh Gupta2022-05-083-13/+73
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Copy Cluster Client, Commands, Commands Parser, Tests for asyncio * Async Cluster Tests: Async/Await * Add Async RedisCluster * cluster: use ERRORS_ALLOW_RETRY from self.__class__ * async_cluster: rework redis_connection, initialize, & close - move redis_connection from NodesManager to ClusterNode & handle all related logic in ClusterNode class - use Locks while initializing or closing - in case of error, close connections instead of instantly reinitializing - create ResourceWarning instead of manually deleting client object - use asyncio.gather to run commands/initialize/close in parallel - inline single use functions - fix test_acl_log for py3.6 * async_cluster: add types * async_cluster: add docs * docs: update sphinx & add sphinx_autodoc_typehints * async_cluster: move TargetNodesT to cluster module * async_cluster/commands: inherit commands from sync class if possible * async_cluster: add benchmark script with aredis & aioredis-cluster * async_cluster: remove logging * async_cluster: inline functions * async_cluster: manage Connection instead of Redis Client * async_cluster/commands: optimize parser * async_cluster: use ensure_future & generators for gather * async_conn: optimize * async_cluster: optimize determine_slot * async_cluster: optimize determine_nodes * async_cluster/parser: optimize _get_moveable_keys * async_cluster: inlined check_slots_coverage * async_cluster: update docstrings * async_cluster: add concurrent test & use read_response/_update_moved_slots without lock Co-authored-by: Chayim <chayim@users.noreply.github.com>
* Vector similarity search example (#2083)dvora-h2022-04-042-0/+108
| | | | | * copy example * fix
* Add Async Support (#1899)Andrew Chen Wang2022-02-224-2/+314
| | | | Co-authored-by: Chayim I. Kirshen <c@kirshen.com> Co-authored-by: dvora-h <dvora.heller@redis.com>
* Add set and get examples (#1916)dogukanteber2022-02-062-0/+303
|
* Add type hints for JSON commands (#1921)dvora-h2022-02-061-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add type hints for json commands * Change json.clear test multi to be up to date with redisjson (#1922) * fix json clear test * fix json clear test * Add support for BZMPOP (#1851) * add bzmpop * add comment * fix pr comment * fix linters * fix pr comments * add client no-evict (#1856) * Add support for ZINTERCARD (#1857) * add zintercard * fix pr comment * linters * Add support for EVAL_RO (#1862) * add sort_ro * mark test as onlynon cluster * delete mark test as onlynoncluster * add eval_ro * fix linters * delete sort_ro * fix pr comment * add type hints * add type hints * linters * Add support for EVALSHA_RO (#1863) * add evalsha-ro * fix pr comment * add type hints * add type hints * Fix naming conventions (#1872) * fix naming convention * fix worng changes * fix naming convention in rootPath
* Fix link in the main page (#1897)dvora-h2022-01-251-1/+1
|
* Documentation fixes: JSON Example, SSL Connection Examples, RTD version (#1887)Chayim2022-01-193-4/+12
|
* Add search-json examples (#1886)dvora-h2022-01-195-180/+218
|
* OCSP Stapling Support (#1873)Chayim2022-01-173-85/+288
|
* Timeseries docs fix (#1877)Chayim2022-01-121-1/+1
|
* Documentation cleanup (#1841)Chayim2021-12-307-102/+123
|
* Connection examples (#1835)dvora-h2021-12-307-1/+452
| | | Co-authored-by: Chayim I. Kirshen <c@kirshen.com>
* Update redismodules.rst (#1822)yanivhershkovich2021-12-221-3/+3
| | | Updated links to RediSearch, RedisGraph and RedisBloom sites as they were all pointing to RedisJSON instead.
* Adding cluster, bloom, and graph docs (#1779)v4.1.0rc2Chayim2021-12-094-11/+145
|
* Added black and isort (#1734)Anas2021-11-301-17/+10
|
* Link Documents for all module commands (#1711)Chayim2021-11-301-1/+1
|
* Splitting documentation for read the docs (#1743)Chayim2021-11-2512-27/+163
|
* 4.0.0 (#1708)v4.0.0Chayim2021-11-151-2/+3
| | | * 4.0.0
* Re-enabling read-the-docs (#1707)Chayim2021-11-144-198/+26
|
* Fixing the package to include commands (#1649)v4.0.0b3Chayim2021-10-261-70/+82
| | | | | * Fixing the package to include commands. Fixes #1645
* repalce redislabs with redis (#1575)Guy Korland2021-09-202-0/+0
| | | Rename "Redis Labs" to "Redis" in the README docs
* Sponsored (#1418)Guy Korland2020-11-091-0/+0
| | | Add note that redis-py is sponsored by Redis Labs
* Remove support for end-of-life Python 2.7 (#1318)Jon Dufresne2020-08-061-14/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Remove support for end-of-life Python 2.7 Python 2.7 is end of life. It is no longer receiving bug fixes, including for security issues. Python 2.7 went EOL on 2020-01-01. For additional details on support Python versions, see: Supported: https://devguide.python.org/#status-of-python-branches EOL: https://devguide.python.org/devcycle/#end-of-life-branches Removing support for EOL Pythons will reduce testing and maintenance resources while allowing the library to move towards a modern Python 3 style. Python 2.7 users can continue to use the previous version of redis-py. Was able to simplify the code: - Removed redis._compat module - Removed __future__ imports - Removed object from class definition (all classes are new style) - Removed long (Python 3 unified numeric types) - Removed deprecated __nonzero__ method - Use simpler Python 3 super() syntax - Use unified OSError exception - Use yield from syntax Co-authored-by: Andy McCurdy <andy@andymccurdy.com>
* Add `redis.sentinel.Sentinel` module documentation (#1165)Rick van Hattem2020-06-291-0/+3
| | | Added directive to document Sentinel module.