Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,6 @@ It's strongly advised to use `relref` because it provides the following advantag

The following needs to be taken into account when using `relref`: The reference `/develop/get-started/data-store` and `/develop/get-started/data-store/` aren't the same. You must use the trailing slash if the referenced article is an `_index.md` file within a folder (e.g., `.../data-store/` for `.../data-store/_index.md`). Otherwise, you should not use the trailing slash (e.g., `.../get-started/data-store.md`).

RelRefs with dots (`.`) and hashtags (`#`) in the reference name, such as `/commands/ft.create` or `/develop/data-types/timeseries/configuration#compaction_policy`, don't seem to work. Please use the `{{< baseurl >}}` as a workaround in that case. Here are a couple of examples:

```
[compaction]({{< baseurl >}}/develop/data-types/timeseries/configuration#compaction_policy)
[FT.CREATE]({{< baseurl >}}/commands/ft.create)
```

### Images

The image shortcode doesn't need to be closed anymore. Here is an example;
Expand Down
2 changes: 1 addition & 1 deletion content/commands/acl-setuser/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ This is a list of all the supported Redis ACL rules:
* `#<hashedpassword>`: Adds the specified hashed password to the list of user passwords. A Redis hashed password is hashed with SHA256 and translated into a hexadecimal string. Example: `#c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2`.
* `<password`: Like `>password` but removes the password instead of adding it.
* `!<hashedpassword>`: Like `#<hashedpassword>` but removes the password instead of adding it.
* `(<rule list>)`: (Available in Redis 7.0 and later) Creates a new selector to match rules against. Selectors are evaluated after the user permissions, and are evaluated according to the order they are defined. If a command matches either the user permissions or any selector, it is allowed. See [selectors]({{< baseurl >}}operate/oss_and_stack/management/security/acl#selectors) for more information.
* `(<rule list>)`: (Available in Redis 7.0 and later) Creates a new selector to match rules against. Selectors are evaluated after the user permissions, and are evaluated according to the order they are defined. If a command matches either the user permissions or any selector, it is allowed. See [selectors]({{< relref "operate/oss_and_stack/management/security/acl#selectors" >}}) for more information.
* `clearselectors`: (Available in Redis 7.0 and later) Deletes all of the selectors attached to the user.
* `reset`: Removes any capability from the user. They are set to off, without passwords, unable to execute any command, unable to access any key.

Expand Down
4 changes: 2 additions & 2 deletions content/commands/bf.add/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ title: BF.ADD
---
Adds an item to a Bloom filter.

This command is similar to [`BF.MADD`]({{< baseurl >}}commands/bf.madd/), except that only one item can be added.
This command is similar to [`BF.MADD`]({{< relref "commands/bf.madd/" >}}), except that only one item can be added.

## Required arguments

<details open><summary><code>key</code></summary>

is key name for a Bloom filter to add the item to.

If `key` does not exist - a new Bloom filter is created with default error rate, capacity, and expansion (see [`BF.RESERVE`]({{< baseurl >}}commands/bf.reserve/)).
If `key` does not exist - a new Bloom filter is created with default error rate, capacity, and expansion (see [`BF.RESERVE`]({{< relref "commands/bf.reserve/" >}})).
</details>

<details open><summary><code>item</code></summary>
Expand Down
2 changes: 1 addition & 1 deletion content/commands/bf.exists/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ title: BF.EXISTS
---
Determines whether a given item was added to a Bloom filter.

This command is similar to [`BF.MEXISTS`]({{< baseurl >}}commands/bf.mexists/), except that only one item can be checked.
This command is similar to [`BF.MEXISTS`]({{< relref "commands/bf.mexists/" >}}), except that only one item can be checked.

## Required arguments

Expand Down
6 changes: 3 additions & 3 deletions content/commands/bf.insert/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ title: BF.INSERT
---
Creates a new Bloom filter if the `key` does not exist using the specified error rate, capacity, and expansion, then adds all specified items to the Bloom Filter.

This command is similar to [`BF.MADD`]({{< baseurl >}}commands/bf.madd/), except that the error rate, capacity, and expansion can be specified. It is a sugarcoated combination of [`BF.RESERVE`]({{< baseurl >}}commands/bf.reserve/) and [`BF.MADD`]({{< baseurl >}}commands/bf.madd/).
This command is similar to [`BF.MADD`]({{< relref "commands/bf.madd/" >}}), except that the error rate, capacity, and expansion can be specified. It is a sugarcoated combination of [`BF.RESERVE`]({{< relref "commands/bf.reserve/" >}}) and [`BF.MADD`]({{< relref "commands/bf.madd/" >}}).

## Required arguments

Expand Down Expand Up @@ -89,14 +89,14 @@ It is an error to specify `NOCREATE` together with either `CAPACITY` or `ERROR`.
Specifies the desired `capacity` for the filter to be created.
This parameter is ignored if the filter already exists.
If the filter is automatically created and this parameter is absent, then the module-level `capacity` is used.
See [`BF.RESERVE`]({{< baseurl >}}commands/bf.reserve/) for more information about the impact of this value.
See [`BF.RESERVE`]({{< relref "commands/bf.reserve/" >}}) for more information about the impact of this value.
</details>

<details open><summary><code>ERROR error</code></summary>

Specifies the `error` ratio of the newly created filter if it does not yet exist.
If the filter is automatically created and `error` is not specified then the module-level error rate is used.
See [`BF.RESERVE`]({{< baseurl >}}commands/bf.reserve/) for more information about the format of this value.
See [`BF.RESERVE`]({{< relref "commands/bf.reserve/" >}}) for more information about the format of this value.
</details>

<details open><summary><code>NONSCALING</code></summary>
Expand Down
10 changes: 5 additions & 5 deletions content/commands/bf.loadchunk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ syntax_fmt: BF.LOADCHUNK key iterator data
syntax_str: iterator data
title: BF.LOADCHUNK
---
Restores a Bloom filter previously saved using [`BF.SCANDUMP`]({{< baseurl >}}commands/bf.scandump/).
Restores a Bloom filter previously saved using [`BF.SCANDUMP`]({{< relref "commands/bf.scandump/" >}}).

See the [`BF.SCANDUMP`]({{< baseurl >}}commands/bf.scandump/) command for example usage.
See the [`BF.SCANDUMP`]({{< relref "commands/bf.scandump/" >}}) command for example usage.

<note><b>Notes</b>

Expand All @@ -49,12 +49,12 @@ is key name for a Bloom filter to restore.

<details open><summary><code>iterator</code></summary>

Iterator value associated with `data` (returned by [`BF.SCANDUMP`]({{< baseurl >}}commands/bf.scandump/))
Iterator value associated with `data` (returned by [`BF.SCANDUMP`]({{< relref "commands/bf.scandump/" >}}))
</details>

<details open><summary><code>data</code></summary>

Current data chunk (returned by [`BF.SCANDUMP`]({{< baseurl >}}commands/bf.scandump/))
Current data chunk (returned by [`BF.SCANDUMP`]({{< relref "commands/bf.scandump/" >}}))
</details>

## Return value
Expand All @@ -66,4 +66,4 @@ Returns one of these replies:

## Examples

See [`BF.SCANDUMP`]({{< baseurl >}}commands/bf.scandump/) for an example.
See [`BF.SCANDUMP`]({{< relref "commands/bf.scandump/" >}}) for an example.
6 changes: 3 additions & 3 deletions content/commands/bf.madd/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,17 @@ title: BF.MADD
---
Adds one or more items to a Bloom filter.

This command is similar to [`BF.ADD`]({{< baseurl >}}commands/bf.add/), except that you can add more than one item.
This command is similar to [`BF.ADD`]({{< relref "commands/bf.add/" >}}), except that you can add more than one item.

This command is similar to [`BF.INSERT`]({{< baseurl >}}commands/bf.insert/), except that the error rate, capacity, and expansion cannot be specified.
This command is similar to [`BF.INSERT`]({{< relref "commands/bf.insert/" >}}), except that the error rate, capacity, and expansion cannot be specified.

## Required arguments

<details open><summary><code>key</code></summary>

is key name for a Bloom filter to add the items to.

If `key` does not exist - a new Bloom filter is created with default error rate, capacity, and expansion (see [`BF.RESERVE`]({{< baseurl >}}commands/bf.reserve/)).
If `key` does not exist - a new Bloom filter is created with default error rate, capacity, and expansion (see [`BF.RESERVE`]({{< relref "commands/bf.reserve/" >}})).
</details>

<details open><summary><code>item...</code></summary>
Expand Down
2 changes: 1 addition & 1 deletion content/commands/bf.mexists/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ title: BF.MEXISTS
---
Determines whether one or more items were added to a Bloom filter.

This command is similar to [`BF.EXISTS`]({{< baseurl >}}commands/bf.exists/), except that more than one item can be checked.
This command is similar to [`BF.EXISTS`]({{< relref "commands/bf.exists/" >}}), except that more than one item can be checked.

## Required arguments

Expand Down
2 changes: 1 addition & 1 deletion content/commands/bf.scandump/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Returns one of these replies:

The Iterator is passed as input to the next invocation of `BF.SCANDUMP`. If _Iterator_ is 0, then it means iteration has completed.

The iterator-data pair should also be passed to [`BF.LOADCHUNK`]({{< baseurl >}}commands/bf.loadchunk/) when restoring the filter.
The iterator-data pair should also be passed to [`BF.LOADCHUNK`]({{< relref "commands/bf.loadchunk/" >}}) when restoring the filter.

- [] on error (invalid arguments, key not found, wrong key type, etc.)

Expand Down
2 changes: 1 addition & 1 deletion content/commands/cf.add/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ title: CF.ADD
Adds an item to the cuckoo filter.

Cuckoo filters can contain the same item multiple times, and consider each addition as separate.
Use [`CF.ADDNX`]({{< baseurl >}}commands/cf.addnx/) to add an item only if it does not exist.
Use [`CF.ADDNX`]({{< relref "commands/cf.addnx/" >}}) to add an item only if it does not exist.

## Required arguments

Expand Down
6 changes: 3 additions & 3 deletions content/commands/cf.addnx/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ title: CF.ADDNX
---
Adds an item to a cuckoo filter if the item does not exist.

This command is similar to the combination of [`CF.EXISTS`]({{< baseurl >}}commands/cf.exists/) and [`CF.ADD`]({{< baseurl >}}commands/cf.add/). It does not add an item into the filter if its fingerprint already exists.
This command is similar to the combination of [`CF.EXISTS`]({{< relref "commands/cf.exists/" >}}) and [`CF.ADD`]({{< relref "commands/cf.add/" >}}). It does not add an item into the filter if its fingerprint already exists.

<note><b>Notes:</b>

- This command is slower than [`CF.ADD`]({{< baseurl >}}commands/cf.add/) because it first checks whether the item exists.
- Since [`CF.EXISTS`]({{< baseurl >}}commands/cf.exists/) can result in false positive, `CF.ADDNX` may not add an item because it is supposedly already exist, which may be wrong.
- This command is slower than [`CF.ADD`]({{< relref "commands/cf.add/" >}}) because it first checks whether the item exists.
- Since [`CF.EXISTS`]({{< relref "commands/cf.exists/" >}}) can result in false positive, `CF.ADDNX` may not add an item because it is supposedly already exist, which may be wrong.

</note>

Expand Down
4 changes: 2 additions & 2 deletions content/commands/cf.count/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ title: CF.COUNT
---
Returns an estimation of the number of times a given item was added to a cuckoo filter.

If you just want to check that a given item was added to a cuckoo filter, use [`CF.EXISTS`]({{< baseurl >}}commands/cf.exists/).
If you just want to check that a given item was added to a cuckoo filter, use [`CF.EXISTS`]({{< relref "commands/cf.exists/" >}}).

## Required arguments

Expand All @@ -48,7 +48,7 @@ is an item to check.

Returns one of these replies:

- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}), where a positive value is an estimation of the number of times `item` was added to the filter. An overestimation is possible, but not an underestimation. `0` means that `key` does not exist or that `item` had not been added to the filter. See note in [`CF.DEL`]({{< baseurl >}}commands/cf.del/).
- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}), where a positive value is an estimation of the number of times `item` was added to the filter. An overestimation is possible, but not an underestimation. `0` means that `key` does not exist or that `item` had not been added to the filter. See note in [`CF.DEL`]({{< relref "commands/cf.del/" >}}).
- [] on error (invalid arguments, wrong key type, etc.)

## Examples
Expand Down
4 changes: 2 additions & 2 deletions content/commands/cf.exists/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ title: CF.EXISTS
---
Determines whether a given item was added to a cuckoo filter.

This command is similar to [`CF.MEXISTS`]({{< baseurl >}}commands/cf.mexists/), except that only one item can be checked.
This command is similar to [`CF.MEXISTS`]({{< relref "commands/cf.mexists/" >}}), except that only one item can be checked.

## Required arguments

Expand All @@ -48,7 +48,7 @@ is an item to check.

Returns one of these replies:

- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}), where `1` means that, with high probability, `item` had already been added to the filter, and `0` means that `key` does not exist or that `item` had not been added to the filter. See note in [`CF.DEL`]({{< baseurl >}}commands/cf.del/).
- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}), where `1` means that, with high probability, `item` had already been added to the filter, and `0` means that `key` does not exist or that `item` had not been added to the filter. See note in [`CF.DEL`]({{< relref "commands/cf.del/" >}}).
- [] on error (invalid arguments, wrong key type, and so on)

## Examples
Expand Down
4 changes: 2 additions & 2 deletions content/commands/cf.insert/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ title: CF.INSERT
---
Adds one or more items to a cuckoo filter, allowing the filter to be created with a custom capacity if it does not exist yet.

This command is similar to [`CF.ADD`]({{< baseurl >}}commands/cf.add/), except that more than one item can be added and capacity can be specified.
This command is similar to [`CF.ADD`]({{< relref "commands/cf.add/" >}}), except that more than one item can be added and capacity can be specified.

## Required arguments

Expand All @@ -70,7 +70,7 @@ If the filter already exists, then this parameter is ignored.

If the filter does not exist yet and this parameter is *not* specified, then the filter is created with the module-level default capacity which is 1024.

See [`CF.RESERVE`]({{< baseurl >}}commands/cf.reserve/) for more information on cuckoo filter capacities.
See [`CF.RESERVE`]({{< relref "commands/cf.reserve/" >}}) for more information on cuckoo filter capacities.
</details>

<details open><summary><code>NOCREATE</code></summary>
Expand Down
8 changes: 4 additions & 4 deletions content/commands/cf.insertnx/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ title: CF.INSERTNX
---
Adds one or more items to a cuckoo filter if they did not exist previously, allowing the filter to be created with a custom capacity if it does not exist yet.

This command is similar to [`CF.ADDNX`]({{< baseurl >}}commands/cf.addnx/), except that more than one item can be added and capacity can be specified.
This command is similar to [`CF.ADDNX`]({{< relref "commands/cf.addnx/" >}}), except that more than one item can be added and capacity can be specified.

<note><b>Notes:</b>

- This command is slower than [`CF.INSERT`]({{< baseurl >}}commands/cf.insert/) because it first checks whether each item exists.
- Since [`CF.EXISTS`]({{< baseurl >}}commands/cf.exists/) can result in false positive, `CF.INSERTNX` may not add an item because it is supposedly already exist, which may be wrong.
- This command is slower than [`CF.INSERT`]({{< relref "commands/cf.insert/" >}}) because it first checks whether each item exists.
- Since [`CF.EXISTS`]({{< relref "commands/cf.exists/" >}}) can result in false positive, `CF.INSERTNX` may not add an item because it is supposedly already exist, which may be wrong.

</note>

Expand Down Expand Up @@ -77,7 +77,7 @@ If the filter already exists, then this parameter is ignored.

If the filter does not exist yet and this parameter is *not* specified, then the filter is created with the module-level default capacity which is 1024.

See [`CF.RESERVE`]({{< baseurl >}}commands/cf.reserve/) for more information on cuckoo filter capacities.
See [`CF.RESERVE`]({{< relref "commands/cf.reserve/" >}}) for more information on cuckoo filter capacities.
</details>

<details open><summary><code>NOCREATE</code></summary>
Expand Down
10 changes: 5 additions & 5 deletions content/commands/cf.loadchunk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ syntax_fmt: CF.LOADCHUNK key iterator data
syntax_str: iterator data
title: CF.LOADCHUNK
---
Restores a cuckoo filter previously saved using [`CF.SCANDUMP`]({{< baseurl >}}commands/cf.scandump/).
Restores a cuckoo filter previously saved using [`CF.SCANDUMP`]({{< relref "commands/cf.scandump/" >}}).

See the [`CF.SCANDUMP`]({{< baseurl >}}commands/cf.scandump/) command for example usage.
See the [`CF.SCANDUMP`]({{< relref "commands/cf.scandump/" >}}) command for example usage.

<note><b>Notes</b>

Expand All @@ -49,12 +49,12 @@ is key name for a cuckoo filter to restore.

<details open><summary><code>iterator</code></summary>

Iterator value associated with `data` (returned by [`CF.SCANDUMP`]({{< baseurl >}}commands/cf.scandump/))
Iterator value associated with `data` (returned by [`CF.SCANDUMP`]({{< relref "commands/cf.scandump/" >}}))
</details>

<details open><summary><code>data</code></summary>

Current data chunk (returned by [`CF.SCANDUMP`]({{< baseurl >}}commands/cf.scandump/))
Current data chunk (returned by [`CF.SCANDUMP`]({{< relref "commands/cf.scandump/" >}}))
</details>

## Return value
Expand All @@ -66,4 +66,4 @@ Returns one of these replies:

## Examples

See [`CF.SCANDUMP`]({{< baseurl >}}commands/cf.scandump/) for an example.
See [`CF.SCANDUMP`]({{< relref "commands/cf.scandump/" >}}) for an example.
4 changes: 2 additions & 2 deletions content/commands/cf.mexists/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ title: CF.MEXISTS
---
Determines whether one or more items were added to a cuckoo filter.

This command is similar to [`CF.EXISTS`]({{< baseurl >}}commands/cf.exists/), except that more than one item can be checked.
This command is similar to [`CF.EXISTS`]({{< relref "commands/cf.exists/" >}}), except that more than one item can be checked.

## Required arguments

Expand All @@ -50,7 +50,7 @@ One or more items to check.

Returns one of these replies:

- [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) - where "1" means that, with high probability, `item` was already added to the filter, and "0" means that `key` does not exist or that `item` had not added to the filter. See note in [`CF.DEL`]({{< baseurl >}}commands/cf.del/).
- [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) - where "1" means that, with high probability, `item` was already added to the filter, and "0" means that `key` does not exist or that `item` had not added to the filter. See note in [`CF.DEL`]({{< relref "commands/cf.del/" >}}).
- [] on error (invalid arguments, wrong key type, etc.)

## Examples
Expand Down
2 changes: 1 addition & 1 deletion content/commands/cf.scandump/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Returns one of these replies:

The Iterator is passed as input to the next invocation of `CF.SCANDUMP`. If _Iterator_ is 0, then it means iteration has completed.

The iterator-data pair should also be passed to [`CF.LOADCHUNK`]({{< baseurl >}}commands/cf.loadchunk/) when restoring the filter.
The iterator-data pair should also be passed to [`CF.LOADCHUNK`]({{< relref "commands/cf.loadchunk/" >}}) when restoring the filter.

- [] on error (invalid arguments, key not found, wrong key type, etc.)

Expand Down
2 changes: 1 addition & 1 deletion content/commands/command-getkeys/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Returns [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}})
`COMMAND GETKEYS` is a helper command to let you find the keys
from a full Redis command.

[`COMMAND`]({{< relref "/commands/command" >}}) provides information on how to find the key names of each command (see `firstkey`, [key specifications]({{< baseurl >}}develop/reference/key-specs#logical-operation-flags), and `movablekeys`),
[`COMMAND`]({{< relref "/commands/command" >}}) provides information on how to find the key names of each command (see `firstkey`, [key specifications]({{< relref "develop/reference/key-specs#logical-operation-flags" >}}), and `movablekeys`),
but in some cases it's not possible to find keys of certain commands and then the entire command must be parsed to discover some / all key names.
You can use `COMMAND GETKEYS` or [`COMMAND GETKEYSANDFLAGS`]({{< relref "/commands/command-getkeysandflags" >}}) to discover key names directly from how Redis parses the commands.

Expand Down
Loading