/
about_FarNet.Redis.help.txt
80 lines (58 loc) · 1.9 KB
/
about_FarNet.Redis.help.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
TOPIC
about_FarNet.Redis
SHORT DESCRIPTION
StackExchange.Redis PowerShell module and FarNet library
LONG DESCRIPTION
The module provides PowerShell friendly wrappers for basic Redis types and
operations. For not yet implemented or advanced operations (like getting
byte[] data) use SERedis API methods directly, see examples in tests.
Redis keys, output simple values and complex type items are strings.
Input values may be anything supported by SERedis, including byte[].
MODULE COMMANDS
Connect and get database instance:
Open-Redis
Save-Redis
Close-Redis
Get-RedisServer
Get data commands:
Get-RedisAny
Get-RedisHash
Get-RedisList
Get-RedisSet
Get-RedisString
Set data commands:
Set-RedisHash
Set-RedisList
Set-RedisSet
Set-RedisString
Key operations:
Get-RedisKey
Set-RedisKey
Test-RedisKey
Remove-RedisKey
Search-RedisKey
Subscriptions:
Register-RedisSub
Unregister-RedisSub
Utility commands:
Export-Redis
Import-Redis
Get-RedisClixml
Set-RedisClixml
Wait-RedisString
REDIS TYPES
For a Redis type { String | Hash | List | Set } use these cmdlets:
* Set-Redis{Type}
Sets or updates values. It returns nothing on simple set operations.
On updates, it returns some result depending on parameters.
* Get-Redis{Type}
Gets values or other details. It always returns some result.
The result type depends on the command and parameters.
* Get-RedisAny
Use this command when the type is unknown or variable.
* Test-RedisKey
Checks for existence of specified keys.
* Remove-RedisKey
Removes specified keys.
SEE ALSO
StackExchange.Redis https://github.com/StackExchange/StackExchange.Redis