Skip to content
Open
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
20 changes: 19 additions & 1 deletion content/doc/addons/materia-kv.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@
Supported value types are:

- Hash
- Set
- String

Find below the list of currently supported commands:
Expand Down Expand Up @@ -181,12 +182,29 @@
| `PEXPIRE` | Set a `key` time to live in milliseconds. After the timeout has expired, the `key` will be automatically deleted. The time to live can be updated using the `PEXPIRE` command or cleared using the `PERSIST` command. |
| `PING` | Returns `PONG` if no argument is provided, otherwise return a copy of the argument as a bulk. |
| `PTTL` | RReturns the remaining time to live of a `key`, in milliseconds. |
| `SADD` | Add the specified members to the set stored at `key`. Specified members that are already a member of this set are ignored. If `key` doesn't exist, a new set is created before adding the specified members. |

Check notice on line 185 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L185

[Google.Passive] In general, use active voice instead of passive voice ('are ignored').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are ignored').", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 185, "column": 122}}}, "severity": "INFO"}

Check notice on line 185 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L185

[Google.Passive] In general, use active voice instead of passive voice ('is created').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is created').", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 185, "column": 169}}}, "severity": "INFO"}
| `SCAN` | Incrementally iterate over a collection of elements. It is a cursor based iterator, this means that at every call of the command, the server returns an updated cursor that the user needs to use as the cursor argument in the next call. An iteration starts when the cursor is set to `0`, and terminates when the cursor returned by the server is `0`. |
| `SCARD` | Returns the set cardinality (number of elements) of the set stored at `key`. |
| `SDIFF` | Returns the members of the set resulting from the difference between the first set and all the successive sets. |
| `SDIFFSTORE` | This command is equal to `SDIFF`, but instead of returning the resulting set, it is stored in `destination`. If `destination` already exists, it is overwritten. |

Check notice on line 189 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L189

[Google.Contractions] Use 'it's' instead of 'it is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 189, "column": 96}}}, "severity": "INFO"}

Check notice on line 189 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L189

[Google.Passive] In general, use active voice instead of passive voice ('is stored').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is stored').", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 189, "column": 99}}}, "severity": "INFO"}

Check notice on line 189 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L189

[Google.Contractions] Use 'it's' instead of 'it is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 189, "column": 160}}}, "severity": "INFO"}
| `SET` | Set `key` to hold the string `value`. If key already holds a value, it is overwritten, regardless of its type. |
| `SETBIT` | Sets or clears the bit at offset in the string value stored at `key`. |
| `SINTER` | Returns the members of the set resulting from the intersection of all the given sets. |
| `SINTERCARD` | Returns the number of elements that would result from the intersection of all given sets. |
| `SINTERSTORE` | This command is equal to `SINTER`, but instead of returning the resulting set, it is stored in `destination`. If `destination` already exists, it is overwritten. |

Check notice on line 194 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L194

[Google.Contractions] Use 'it's' instead of 'it is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 194, "column": 98}}}, "severity": "INFO"}

Check notice on line 194 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L194

[Google.Passive] In general, use active voice instead of passive voice ('is stored').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is stored').", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 194, "column": 101}}}, "severity": "INFO"}

Check notice on line 194 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L194

[Google.Contractions] Use 'it's' instead of 'it is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 194, "column": 162}}}, "severity": "INFO"}
| `SISMEMBER` | Returns if `member` is a member of the set stored at `key`. |
| `SMEMBERS` | Returns all the members of the set value stored at `key`. |
| `SMISMEMBER` | Returns whether each member is a member of the set stored at `key`. For every member, `1` is returned if the value is a member of the set, or `0` if the element is not a member of the set or if `key` doesn't exist. |

Check notice on line 197 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L197

[Google.Passive] In general, use active voice instead of passive voice ('is returned').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is returned').", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 197, "column": 108}}}, "severity": "INFO"}

Check notice on line 197 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L197

[Google.Contractions] Use 'isn't' instead of 'is not'.
Raw output
{"message": "[Google.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 197, "column": 179}}}, "severity": "INFO"}
| `SMOVE` | Move `member` from the set at `source` to the set at `destination`. This operation is atomic. In every given moment the element will appear to be a member of `source` or `destination` for other clients. |

Check warning on line 198 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L198

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 198, "column": 141}}}, "severity": "WARNING"}
| `SPOP` | Removes and returns one or more random members from the set value store at `key`. |
| `SRANDMEMBER` | When called with just the `key` argument, return a random element from the set value stored at `key`. |
| `SREM` | Remove the specified members from the set stored at `key`. Specified members that are not a member of this set are ignored. If `key` doesn't exist, it is treated as an empty set and this command returns `0`. |

Check notice on line 201 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L201

[Google.Contractions] Use 'aren't' instead of 'are not'.
Raw output
{"message": "[Google.Contractions] Use 'aren't' instead of 'are not'.", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 201, "column": 94}}}, "severity": "INFO"}

Check notice on line 201 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L201

[Google.Passive] In general, use active voice instead of passive voice ('are ignored').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are ignored').", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 201, "column": 123}}}, "severity": "INFO"}

Check notice on line 201 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L201

[Google.Contractions] Use 'it's' instead of 'it is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 201, "column": 160}}}, "severity": "INFO"}

Check notice on line 201 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L201

[Google.Passive] In general, use active voice instead of passive voice ('is treated').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is treated').", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 201, "column": 163}}}, "severity": "INFO"}
| `SSCAN` | Incrementally iterate over set elements. It is a cursor based iterator, this means that at every call of the command, the server returns an updated cursor that the user needs to use as the cursor argument in the next call. An iteration starts when the cursor is set to `0`, and terminates when the cursor returned by the server is `0`. |

Check notice on line 202 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L202

[Google.Contractions] Use 'it's' instead of 'It is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'It is'.", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 202, "column": 54}}}, "severity": "INFO"}

Check notice on line 202 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L202

[Google.Passive] In general, use active voice instead of passive voice ('is set').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is set').", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 202, "column": 272}}}, "severity": "INFO"}
| `SUNION` | Returns the members of the set resulting from the union of all the given sets. |
| `SUNIONSTORE` | This command is equal to `SUNION`, but instead of returning the resulting set, it is stored in `destination`. If `destination` already exists, it is overwritten. |

Check notice on line 204 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L204

[Google.Contractions] Use 'it's' instead of 'it is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 204, "column": 98}}}, "severity": "INFO"}

Check notice on line 204 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L204

[Google.Passive] In general, use active voice instead of passive voice ('is stored').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is stored').", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 204, "column": 101}}}, "severity": "INFO"}

Check notice on line 204 in content/doc/addons/materia-kv.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/materia-kv.md#L204

[Google.Contractions] Use 'it's' instead of 'it is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "content/doc/addons/materia-kv.md", "range": {"start": {"line": 204, "column": 162}}}, "severity": "INFO"}
| `STRLEN` | Returns the length of the string value stored at `key`. An error is returned when key holds a non-string value. |
| `TTL` | Returns the remaining time to live of a `key`, in seconds. |
| `TYPE` | Returns the string representation of the type of the value stored at `key`. Can be: `hash`, `list` or `string`. |
| `TYPE` | Returns the string representation of the type of the value stored at `key`. Can be: `hash`, `list`, `set` or `string`. |

### JSON commands

Expand Down
Loading