From da1d65561bdebcf01099b71f9a172f440bbfa2e4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 3 Aug 2024 20:06:34 +0000 Subject: [PATCH] Deployed cd58a7c with MkDocs version: 1.6.0 --- .nojekyll | 0 404.html | 774 ++ about/changelog/index.html | 2529 +++++++ about/contributing/index.html | 1270 ++++ about/license/index.html | 883 +++ ads.txt | 1 + assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.fe8b6f2b.min.js | 29 + assets/javascripts/bundle.fe8b6f2b.min.js.map | 7 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.el.min.js | 1 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.he.min.js | 1 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.hy.min.js | 1 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.kn.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + assets/javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.te.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 +++++++++++++++++ .../workers/search.b8dbb3d2.min.js | 42 + .../workers/search.b8dbb3d2.min.js.map | 7 + assets/stylesheets/main.3cba04c6.min.css | 1 + assets/stylesheets/main.3cba04c6.min.css.map | 1 + assets/stylesheets/palette.06af60db.min.css | 1 + .../stylesheets/palette.06af60db.min.css.map | 1 + guides/implement-command/index.html | 1068 +++ guides/test-case/index.html | 893 +++ index.html | 1283 ++++ overrides/main.html | 6 + redis-commands/Redis/index.html | 1917 +++++ redis-commands/RedisBloom/index.html | 1099 +++ redis-commands/RedisGraph/index.html | 895 +++ redis-commands/RedisJson/index.html | 969 +++ redis-commands/RedisSearch/index.html | 935 +++ redis-commands/RedisTimeSeries/index.html | 907 +++ redis-stack/index.html | 1064 +++ requirements.txt | 2 + search/search_index.json | 1 + sitemap.xml | 3 + sitemap.xml.gz | Bin 0 -> 127 bytes 64 files changed, 23789 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 about/changelog/index.html create mode 100644 about/contributing/index.html create mode 100644 about/license/index.html create mode 100644 ads.txt create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.fe8b6f2b.min.js create mode 100644 assets/javascripts/bundle.fe8b6f2b.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.el.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js.map create mode 100644 assets/stylesheets/main.3cba04c6.min.css create mode 100644 assets/stylesheets/main.3cba04c6.min.css.map create mode 100644 assets/stylesheets/palette.06af60db.min.css create mode 100644 assets/stylesheets/palette.06af60db.min.css.map create mode 100644 guides/implement-command/index.html create mode 100644 guides/test-case/index.html create mode 100644 index.html create mode 100644 overrides/main.html create mode 100644 redis-commands/Redis/index.html create mode 100644 redis-commands/RedisBloom/index.html create mode 100644 redis-commands/RedisGraph/index.html create mode 100644 redis-commands/RedisJson/index.html create mode 100644 redis-commands/RedisSearch/index.html create mode 100644 redis-commands/RedisTimeSeries/index.html create mode 100644 redis-stack/index.html create mode 100644 requirements.txt create mode 100644 search/search_index.json create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..fffa8ce8 --- /dev/null +++ b/404.html @@ -0,0 +1,774 @@ + + + +
+ + + + + + + + + + + + + + + + + + +XREAD
behavior when COUNT
is not provided but BLOCKING
is provided #308TDIGEST.ADD
,TDIGEST.BYRANK
,TDIGEST.BYREVRANK
,TDIGEST.CDF
, TDIGEST.CREATE
, TDIGEST.INFO
,
+ TDIGEST.MAX
, TDIGEST.MERGE
, TDIGEST.MIN
, TDIGEST.QUANTILE
, TDIGEST.RANK
, TDIGEST.RESET
, TDIGEST.REVRANK
,
+ TDIGEST.TRIMMED_MEAN
.Self
from typing vs. typing_extensionFAKEREDIS_LUA_VERSION
#287++Note: Since connection params are defaulted to be the same between async and sync connections, different FakeRedis +connections with the same connection params (or without connection parameters) will share the same server data +structure.
+
xinfo_stream
raises exception when stream does not exist #296TOPK.INFO
, TOPK.LIST
, TOPK.RESERVE
,
+ TOPK.ADD
, TOPK.COUNT
, TOPK.QUERY
, TOPK.INCRBY
) #278@testtools.run_test_if_redispy_ver
XREAD
bug #256PUBSUB NUMPAT
#195, SSUBSCRIBE
#199, SPUBLISH
#198,
+ SUNSUBSCRIBE
#200, PUBSUB SHARDCHANNELS
#196, PUBSUB SHARDNUMSUB
#197We'd like to thank all the contributors who worked on this release!
+ +version
for async FakeRedis #205BLMOVE
#182,HRANDFIELD
#156JSON.MSET
Connection.read_response
arguments used in redis-py 4.5.5 and 5.0.0XREAD
#147FakeConnection
.xrange
xrevrange
XTRIM
MAXLEN
, MAXID
, LIMIT
arguments for XADD
commandZRANGE
arguments for ZRANGE
command #127JSON.ARRINDEX
, JSON.OBJLEN
, JSON.OBJKEYS
,
+ JSON.ARRPOP
, JSON.ARRTRIM
, JSON.NUMINCRBY
, JSON.NUMMULTBY
,
+ XADD
, XLEN
, XRANGE
, XREVRANGE
JSON.TYPE
, JSON.ARRLEN
and JSON.ARRAPPEND
streams_mixin.py
and test_streams_commands.py
Full Changelog: https://github.com/cunla/fakeredis-py/compare/v2.5.0...v2.6.0
+BITPOS
(bitmap command) (#112)We'd like to thank all the contributors who worked on this release!
+ +Full Changelog: https://github.com/cunla/fakeredis-py/compare/v2.4.0...v2.5.0
+Full Changelog: https://github.com/cunla/fakeredis-py/compare/v2.3.0...v2.4.0
+GETEX
(#102)JSON.STRAPPEND
(json command) (#98)JSON.STRLEN
, JSON.TOGGLE
and fix bugs with JSON.DEL
(#96)PUBSUB CHANNELS
, PUBSUB NUMSUB
Full Changelog: https://github.com/cunla/fakeredis-py/compare/v2.2.0...v2.3.0
+JSON.CLEAR
(#87)Full Changelog: https://github.com/cunla/fakeredis-py/compare/v2.1.0...v2.2.0
+We'd like to thank all the contributors who worked on this release!
+@hyeongguen-song, @the-wondersmith
+Full Changelog: https://github.com/cunla/fakeredis-py/compare/v2.0.0...v2.1.0
+Full Changelog: https://github.com/cunla/fakeredis-py/compare/v1.10.1...v2.0.0
+zmscore
by @the-wondersmith in #67Full Changelog: https://github.com/cunla/fakeredis-py/compare/v1.10.0...v1.10.1
+GETDEL
and SINTERCARD
support in #57BZPOPMIN
/BZPOPMAX
support in #60Full Changelog: https://github.com/cunla/fakeredis-py/compare/v1.9.4...v1.10.0
+Full Changelog: https://github.com/cunla/fakeredis-py/compare/v1.9.2...v1.9.3
+Full Changelog: https://github.com/cunla/fakeredis-py/compare/v1.9.1...v1.9.2
+Full Changelog: https://github.com/cunla/fakeredis-py/compare/v1.9.0...v1.9.1
+Full Changelog: https://github.com/cunla/fakeredis-py/compare/v1.8.2...v1.9.0
+publish
GitHub action to create an issue on failure by @terencehonles
+ in #33release draft
job in #37Full Changelog: https://github.com/dsoftwareinc/fakeredis-py/compare/v1.8.1...v1.8.2
+Full Changelog: https://github.com/dsoftwareinc/fakeredis-py/compare/v1.8...v1.8.1
+Full Changelog: https://github.com/dsoftwareinc/fakeredis-py/compare/v1.7.6.1...v1.8
+redis.asyncio
by @zhongkechen in #10Full Changelog: https://github.com/dsoftwareinc/fakeredis-py/compare/v1.7.5...v1.7.6
+Full Changelog: https://github.com/dsoftwareinc/fakeredis-py/compare/v1.7.4...v1.7.5
+Full Changelog: https://github.com/dsoftwareinc/fakeredis-py/compare/1.7.1...v1.7.4
+ + + + + + + + + + + + + + + + + + +First off, thanks for taking the time to contribute! ❤️
+All types of contributions are encouraged and valued. +See the table of contents for different ways to help and details about how this project handles +them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for +the maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
+++And if you like the project, but just don't have time to contribute, that's fine.
+There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
++
+- Star the project
+- Tweet about it
+- Refer to this project in your project's readme
+- Mention the project at local meetups and tell your friends/colleagues
+
This project and everyone participating in it is governed by the +fakeredis Code of Conduct. +By participating, you are expected to uphold this code. Please report unacceptable behavior +to daniel@moransoftware.ca.
+++If you want to ask a question, we assume that you have read the +available Documentation.
+
Before you ask a question, it is best to search for existing Issues that +might help you. In case you have found a suitable issue and still need clarification, you can write your question in +this issue. It is also advisable to search the internet for answers first.
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+We will then take care of the issue as soon as possible.
+ + +++Legal Notice ¶
+When contributing to this project, you must agree that you have authored 100% of the content, that you have the +necessary rights to the content and that the content you contribute may be provided under the project license.
+
A good bug report shouldn't leave others needing to chase you up for more information. +Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. +Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+++You must never report security related issues, vulnerabilities or bugs, including sensitive information +to the issue tracker, or elsewhere in public. +Instead, sensitive bugs must be sent by email to daniel@moransoftware.ca.
+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+Once it's filed:
+needs-repro
. Bugs
+ with the needs-repro
tag will not be addressed until they are reproduced.needs-fix
, as well as possibly other tags (such
+ as critical
), and the issue will be left to be implemented by someone.This section guides you through submitting an enhancement suggestion for fakeredis, including completely new features +and minor improvements to existing functionality. Following these guidelines will help maintainers and the community +to understand your suggestion and find related suggestions.
+Enhancement suggestions are tracked as GitHub issues.
+Unsure where to begin contributing? You can start by looking through +help-wanted issues.
+Never contributed to open source before? Here are a couple of friendly +tutorials:
+ +pip install poetry
poetry install
poetry run pytest -v
docker-compose up redis6
or docker-compose up redis7
to run redis.poetry run pytest -v --cov=fakeredis --cov-branch
+ and then you can run coverage report
.docs/
folder.Taken from conventional commits
+ +The commit contains the following structural elements to communicate intent to the consumers of your library:
+fix:
a commit of the type fix patches a bug in your codebase (this correlates with PATCH
in Semantic Versioning).feat:
a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR
in Semantic
+ Versioning).BREAKING CHANGE:
a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a
+ breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any
+ type.fix:
and feat:
are allowed, for example, @commitlint/config-conventional
(based on the Angular
+ convention) recommends build:
, chore:
, ci:
, docs:
, style:
, refactor:
, perf:
, test:
, and others.BREAKING CHANGE: <description>
may be provided and follow a convention similar to
+ git trailer format.Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic +Versioning (unless they include a BREAKING CHANGE). A scope may be provided to a commit’s type, to provide additional +contextual information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.
+If you wish to be added to the project team as a collaborator, please send +a message to daniel@moransoftware.ca with explanation.
+ + + + + + + + + + + + + + + +The legal stuff.
+BSD 3-Clause License
+Copyright © 2022-, Daniel Moran, 2017-2018, Bruce Merry, 2011 James Saryerwinnie, +All rights reserved.
+Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met:
+Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution.
+Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ + + + + + + + + + + + + + + +