Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@cunla
cunla committed Feb 23, 2023
1 parent 8192a91 commit cf18595
Show file tree
Hide file tree
Showing 9 changed files with 308 additions and 2,401 deletions.
398 changes: 199 additions & 199 deletions docs/redis-commands/Redis.md
View file

Large diffs are not rendered by default.

96 changes: 48 additions & 48 deletions docs/redis-commands/RedisBloom.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,39 @@ Module currently not implemented in fakeredis.
### Unsupported bf commands
> To implement support for a command, see [here](/guides/implement-command/)
#### [BF.RESERVE](https://redis.io/commands/bf.reserve/)
#### [BF.RESERVE](https://redis.io/commands/bf.reserve/) <small>(not implemented)</small>

Creates a new Bloom Filter

#### [BF.ADD](https://redis.io/commands/bf.add/)
#### [BF.ADD](https://redis.io/commands/bf.add/) <small>(not implemented)</small>

Adds an item to a Bloom Filter

#### [BF.MADD](https://redis.io/commands/bf.madd/)
#### [BF.MADD](https://redis.io/commands/bf.madd/) <small>(not implemented)</small>

Adds one or more items to a Bloom Filter. A filter will be created if it does not exist

#### [BF.INSERT](https://redis.io/commands/bf.insert/)
#### [BF.INSERT](https://redis.io/commands/bf.insert/) <small>(not implemented)</small>

Adds one or more items to a Bloom Filter. A filter will be created if it does not exist

#### [BF.EXISTS](https://redis.io/commands/bf.exists/)
#### [BF.EXISTS](https://redis.io/commands/bf.exists/) <small>(not implemented)</small>

Checks whether an item exists in a Bloom Filter

#### [BF.MEXISTS](https://redis.io/commands/bf.mexists/)
#### [BF.MEXISTS](https://redis.io/commands/bf.mexists/) <small>(not implemented)</small>

Checks whether one or more items exist in a Bloom Filter

#### [BF.SCANDUMP](https://redis.io/commands/bf.scandump/)
#### [BF.SCANDUMP](https://redis.io/commands/bf.scandump/) <small>(not implemented)</small>

Begins an incremental save of the bloom filter

#### [BF.LOADCHUNK](https://redis.io/commands/bf.loadchunk/)
#### [BF.LOADCHUNK](https://redis.io/commands/bf.loadchunk/) <small>(not implemented)</small>

Restores a filter previously saved using SCANDUMP

#### [BF.INFO](https://redis.io/commands/bf.info/)
#### [BF.INFO](https://redis.io/commands/bf.info/) <small>(not implemented)</small>

Returns information about a Bloom Filter

Expand All @@ -47,51 +47,51 @@ Returns information about a Bloom Filter
### Unsupported cf commands
> To implement support for a command, see [here](/guides/implement-command/)
#### [CF.RESERVE](https://redis.io/commands/cf.reserve/)
#### [CF.RESERVE](https://redis.io/commands/cf.reserve/) <small>(not implemented)</small>

Creates a new Cuckoo Filter

#### [CF.ADD](https://redis.io/commands/cf.add/)
#### [CF.ADD](https://redis.io/commands/cf.add/) <small>(not implemented)</small>

Adds an item to a Cuckoo Filter

#### [CF.ADDNX](https://redis.io/commands/cf.addnx/)
#### [CF.ADDNX](https://redis.io/commands/cf.addnx/) <small>(not implemented)</small>

Adds an item to a Cuckoo Filter if the item did not exist previously.

#### [CF.INSERT](https://redis.io/commands/cf.insert/)
#### [CF.INSERT](https://redis.io/commands/cf.insert/) <small>(not implemented)</small>

Adds one or more items to a Cuckoo Filter. A filter will be created if it does not exist

#### [CF.INSERTNX](https://redis.io/commands/cf.insertnx/)
#### [CF.INSERTNX](https://redis.io/commands/cf.insertnx/) <small>(not implemented)</small>

Adds one or more items to a Cuckoo Filter if the items did not exist previously. A filter will be created if it does not exist

#### [CF.EXISTS](https://redis.io/commands/cf.exists/)
#### [CF.EXISTS](https://redis.io/commands/cf.exists/) <small>(not implemented)</small>

Checks whether one or more items exist in a Cuckoo Filter

#### [CF.MEXISTS](https://redis.io/commands/cf.mexists/)
#### [CF.MEXISTS](https://redis.io/commands/cf.mexists/) <small>(not implemented)</small>

Checks whether one or more items exist in a Cuckoo Filter

#### [CF.DEL](https://redis.io/commands/cf.del/)
#### [CF.DEL](https://redis.io/commands/cf.del/) <small>(not implemented)</small>

Deletes an item from a Cuckoo Filter

#### [CF.COUNT](https://redis.io/commands/cf.count/)
#### [CF.COUNT](https://redis.io/commands/cf.count/) <small>(not implemented)</small>

Return the number of times an item might be in a Cuckoo Filter

#### [CF.SCANDUMP](https://redis.io/commands/cf.scandump/)
#### [CF.SCANDUMP](https://redis.io/commands/cf.scandump/) <small>(not implemented)</small>

Begins an incremental save of the bloom filter

#### [CF.LOADCHUNK](https://redis.io/commands/cf.loadchunk/)
#### [CF.LOADCHUNK](https://redis.io/commands/cf.loadchunk/) <small>(not implemented)</small>

Restores a filter previously saved using SCANDUMP

#### [CF.INFO](https://redis.io/commands/cf.info/)
#### [CF.INFO](https://redis.io/commands/cf.info/) <small>(not implemented)</small>

Returns information about a Cuckoo Filter

Expand All @@ -100,27 +100,27 @@ Returns information about a Cuckoo Filter
### Unsupported cms commands
> To implement support for a command, see [here](/guides/implement-command/)
#### [CMS.INITBYDIM](https://redis.io/commands/cms.initbydim/)
#### [CMS.INITBYDIM](https://redis.io/commands/cms.initbydim/) <small>(not implemented)</small>

Initializes a Count-Min Sketch to dimensions specified by user

#### [CMS.INITBYPROB](https://redis.io/commands/cms.initbyprob/)
#### [CMS.INITBYPROB](https://redis.io/commands/cms.initbyprob/) <small>(not implemented)</small>

Initializes a Count-Min Sketch to accommodate requested tolerances.

#### [CMS.INCRBY](https://redis.io/commands/cms.incrby/)
#### [CMS.INCRBY](https://redis.io/commands/cms.incrby/) <small>(not implemented)</small>

Increases the count of one or more items by increment

#### [CMS.QUERY](https://redis.io/commands/cms.query/)
#### [CMS.QUERY](https://redis.io/commands/cms.query/) <small>(not implemented)</small>

Returns the count for one or more items in a sketch

#### [CMS.MERGE](https://redis.io/commands/cms.merge/)
#### [CMS.MERGE](https://redis.io/commands/cms.merge/) <small>(not implemented)</small>

Merges several sketches into one sketch

#### [CMS.INFO](https://redis.io/commands/cms.info/)
#### [CMS.INFO](https://redis.io/commands/cms.info/) <small>(not implemented)</small>

Returns information about a sketch

Expand All @@ -129,31 +129,31 @@ Returns information about a sketch
### Unsupported topk commands
> To implement support for a command, see [here](/guides/implement-command/)
#### [TOPK.RESERVE](https://redis.io/commands/topk.reserve/)
#### [TOPK.RESERVE](https://redis.io/commands/topk.reserve/) <small>(not implemented)</small>

Initializes a TopK with specified parameters

#### [TOPK.ADD](https://redis.io/commands/topk.add/)
#### [TOPK.ADD](https://redis.io/commands/topk.add/) <small>(not implemented)</small>

Increases the count of one or more items by increment

#### [TOPK.INCRBY](https://redis.io/commands/topk.incrby/)
#### [TOPK.INCRBY](https://redis.io/commands/topk.incrby/) <small>(not implemented)</small>

Increases the count of one or more items by increment

#### [TOPK.QUERY](https://redis.io/commands/topk.query/)
#### [TOPK.QUERY](https://redis.io/commands/topk.query/) <small>(not implemented)</small>

Checks whether one or more items are in a sketch

#### [TOPK.COUNT](https://redis.io/commands/topk.count/)
#### [TOPK.COUNT](https://redis.io/commands/topk.count/) <small>(not implemented)</small>

Return the count for one or more items are in a sketch

#### [TOPK.LIST](https://redis.io/commands/topk.list/)
#### [TOPK.LIST](https://redis.io/commands/topk.list/) <small>(not implemented)</small>

Return full list of items in Top K list

#### [TOPK.INFO](https://redis.io/commands/topk.info/)
#### [TOPK.INFO](https://redis.io/commands/topk.info/) <small>(not implemented)</small>

Returns information about a sketch

Expand All @@ -162,59 +162,59 @@ Returns information about a sketch
### Unsupported tdigest commands
> To implement support for a command, see [here](/guides/implement-command/)
#### [TDIGEST.CREATE](https://redis.io/commands/tdigest.create/)
#### [TDIGEST.CREATE](https://redis.io/commands/tdigest.create/) <small>(not implemented)</small>

Allocates memory and initializes a new t-digest sketch

#### [TDIGEST.RESET](https://redis.io/commands/tdigest.reset/)
#### [TDIGEST.RESET](https://redis.io/commands/tdigest.reset/) <small>(not implemented)</small>

Resets a t-digest sketch: empty the sketch and re-initializes it.

#### [TDIGEST.ADD](https://redis.io/commands/tdigest.add/)
#### [TDIGEST.ADD](https://redis.io/commands/tdigest.add/) <small>(not implemented)</small>

Adds one or more observations to a t-digest sketch

#### [TDIGEST.MERGE](https://redis.io/commands/tdigest.merge/)
#### [TDIGEST.MERGE](https://redis.io/commands/tdigest.merge/) <small>(not implemented)</small>

Merges multiple t-digest sketches into a single sketch

#### [TDIGEST.MIN](https://redis.io/commands/tdigest.min/)
#### [TDIGEST.MIN](https://redis.io/commands/tdigest.min/) <small>(not implemented)</small>

Returns the minimum observation value from a t-digest sketch

#### [TDIGEST.MAX](https://redis.io/commands/tdigest.max/)
#### [TDIGEST.MAX](https://redis.io/commands/tdigest.max/) <small>(not implemented)</small>

Returns the maximum observation value from a t-digest sketch

#### [TDIGEST.QUANTILE](https://redis.io/commands/tdigest.quantile/)
#### [TDIGEST.QUANTILE](https://redis.io/commands/tdigest.quantile/) <small>(not implemented)</small>

Returns, for each input fraction, an estimation of the value (floating point) that is smaller than the given fraction of observations

#### [TDIGEST.CDF](https://redis.io/commands/tdigest.cdf/)
#### [TDIGEST.CDF](https://redis.io/commands/tdigest.cdf/) <small>(not implemented)</small>

Returns, for each input value, an estimation of the fraction (floating-point) of (observations smaller than the given value + half the observations equal to the given value)

#### [TDIGEST.TRIMMED_MEAN](https://redis.io/commands/tdigest.trimmed_mean/)
#### [TDIGEST.TRIMMED_MEAN](https://redis.io/commands/tdigest.trimmed_mean/) <small>(not implemented)</small>

Returns an estimation of the mean value from the sketch, excluding observation values outside the low and high cutoff quantiles

#### [TDIGEST.RANK](https://redis.io/commands/tdigest.rank/)
#### [TDIGEST.RANK](https://redis.io/commands/tdigest.rank/) <small>(not implemented)</small>

Returns, for each input value (floating-point), the estimated rank of the value (the number of observations in the sketch that are smaller than the value + half the number of observations that are equal to the value)

#### [TDIGEST.REVRANK](https://redis.io/commands/tdigest.revrank/)
#### [TDIGEST.REVRANK](https://redis.io/commands/tdigest.revrank/) <small>(not implemented)</small>

Returns, for each input value (floating-point), the estimated reverse rank of the value (the number of observations in the sketch that are larger than the value + half the number of observations that are equal to the value)

#### [TDIGEST.BYRANK](https://redis.io/commands/tdigest.byrank/)
#### [TDIGEST.BYRANK](https://redis.io/commands/tdigest.byrank/) <small>(not implemented)</small>

Returns, for each input rank, an estimation of the value (floating-point) with that rank

#### [TDIGEST.BYREVRANK](https://redis.io/commands/tdigest.byrevrank/)
#### [TDIGEST.BYREVRANK](https://redis.io/commands/tdigest.byrevrank/) <small>(not implemented)</small>

Returns, for each input reverse rank, an estimation of the value (floating-point) with that reverse rank

#### [TDIGEST.INFO](https://redis.io/commands/tdigest.info/)
#### [TDIGEST.INFO](https://redis.io/commands/tdigest.info/) <small>(not implemented)</small>

Returns information and statistics about a t-digest sketch

Expand Down
18 changes: 9 additions & 9 deletions docs/redis-commands/RedisGraph.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,39 @@ Module currently not implemented in fakeredis.
### Unsupported graph commands
> To implement support for a command, see [here](/guides/implement-command/)
#### [GRAPH.QUERY](https://redis.io/commands/graph.query/)
#### [GRAPH.QUERY](https://redis.io/commands/graph.query/) <small>(not implemented)</small>

Executes the given query against a specified graph

#### [GRAPH.RO_QUERY](https://redis.io/commands/graph.ro_query/)
#### [GRAPH.RO_QUERY](https://redis.io/commands/graph.ro_query/) <small>(not implemented)</small>

Executes a given read only query against a specified graph

#### [GRAPH.DELETE](https://redis.io/commands/graph.delete/)
#### [GRAPH.DELETE](https://redis.io/commands/graph.delete/) <small>(not implemented)</small>

Completely removes the graph and all of its entities

#### [GRAPH.EXPLAIN](https://redis.io/commands/graph.explain/)
#### [GRAPH.EXPLAIN](https://redis.io/commands/graph.explain/) <small>(not implemented)</small>

Returns a query execution plan without running the query

#### [GRAPH.PROFILE](https://redis.io/commands/graph.profile/)
#### [GRAPH.PROFILE](https://redis.io/commands/graph.profile/) <small>(not implemented)</small>

Executes a query and returns an execution plan augmented with metrics for each operation's execution

#### [GRAPH.SLOWLOG](https://redis.io/commands/graph.slowlog/)
#### [GRAPH.SLOWLOG](https://redis.io/commands/graph.slowlog/) <small>(not implemented)</small>

Returns a list containing up to 10 of the slowest queries issued against the given graph

#### [GRAPH.CONFIG GET](https://redis.io/commands/graph.config-get/)
#### [GRAPH.CONFIG GET](https://redis.io/commands/graph.config-get/) <small>(not implemented)</small>

Retrieves a RedisGraph configuration

#### [GRAPH.CONFIG SET](https://redis.io/commands/graph.config-set/)
#### [GRAPH.CONFIG SET](https://redis.io/commands/graph.config-set/) <small>(not implemented)</small>

Updates a RedisGraph configuration

#### [GRAPH.LIST](https://redis.io/commands/graph.list/)
#### [GRAPH.LIST](https://redis.io/commands/graph.list/) <small>(not implemented)</small>

Lists all graph keys in the keyspace

Expand Down
8 changes: 4 additions & 4 deletions docs/redis-commands/RedisJson.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,19 +86,19 @@ Returns the type of the JSON value at path
### Unsupported json commands
> To implement support for a command, see [here](/guides/implement-command/)
#### [JSON.RESP](https://redis.io/commands/json.resp/)
#### [JSON.RESP](https://redis.io/commands/json.resp/) <small>(not implemented)</small>

Returns the JSON value at path in Redis Serialization Protocol (RESP)

#### [JSON.DEBUG](https://redis.io/commands/json.debug/)
#### [JSON.DEBUG](https://redis.io/commands/json.debug/) <small>(not implemented)</small>

Debugging container command

#### [JSON.DEBUG HELP](https://redis.io/commands/json.debug-help/)
#### [JSON.DEBUG HELP](https://redis.io/commands/json.debug-help/) <small>(not implemented)</small>

Shows helpful information

#### [JSON.DEBUG MEMORY](https://redis.io/commands/json.debug-memory/)
#### [JSON.DEBUG MEMORY](https://redis.io/commands/json.debug-memory/) <small>(not implemented)</small>

Reports the size in bytes of a key

Expand Down
Loading

0 comments on commit cf18595

Please sign in to comment.