FarNet.Redis 0.7.8

FarNet.Redis

StackExchange.Redis PowerShell module and FarNet library

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[].

Packages:

• PowerShell 7.4 module, PSGallery FarNet.Redis
• FarNet library, NuGet FarNet.Redis

PowerShell module

You may install the PowerShell module by this command:

Install-Module -Name FarNet.Redis

Explore, see also about_FarNet.Redis.help.txt:

# import and get module commands
Import-Module -Name FarNet.Redis
Get-Command -Module FarNet.Redis

# get module and commands help
help about_FarNet.Redis
help Open-Redis
help Set-RedisString
help Get-RedisString
...

FarNet library

To install as the FarNet library FarNet.Redis, follow these steps.
The NuGet package is installed to %FARHOME%\FarNet\Lib\FarNet.Redis.

See also FarNet.RedisKit, the module for managing Redis data in Far Manager.

Library assets:

• StackExchange.Redis.dll, FarNet.Redis.dll

  General purpose Redis client and helper assemblies.
  They are designed for using in C#, F#, PowerShell.

• FarNet.Redis.psd1, PS.FarNet.Redis.dll

  PowerShell module files.

• FarNet.Redis.ini

  F# scripts configuration, FarNet.FSharpFar.

The PowerShell module may be imported as:

Import-Module $env:FARHOME\FarNet\Lib\FarNet.Redis

Expose the module as a symbolic link or junction

Consider exposing this module, so that you can:

Import-Module FarNet.Redis

(1) Choose one of the module directories, see $env:PSModulePath.

(2) Change to the selected directory and create the symbolic link

New-Item FarNet.Redis -ItemType SymbolicLink -Value $env:FARHOME\FarNet\Lib\FarNet.Redis

(3) Alternatively, you may create the similar folder junction point in Far Manager using AltF6.

Then you may update the FarNet package with new versions. The symbolic link or junction do not have to be updated, they point to the same location.

Examples

See tests for all examples.

PowerShell

Import-Module FarNet.Redis
$db = Open-Redis 127.0.0.1:3278
Set-RedisString test:key1 Hello
Get-RedisString test:key1

F#

open StackExchange.Redis
let db = DB.Open("127.0.0.1:3278")
db.StringSet("test:key1", "Hello")
db.StringGet("test:key1")

Garnet server

Microsoft.Garnet is the Redis like server, especially useful on Windows.

Use a tiny project like GarnetServer to build and run the server.
Or download ready to run binaries from Garnet Releases.

Known issues

For faster connection to local servers, consider using 127.0.0.1 instead of localhost in configuration strings.

Garnet: The same key may simultaneously exist as string and object, see #358. Mind expected inconsistencies and not unique Search-RedisKey results.

Garnet: Do not use saved checkpoints with different server versions, format is not yet stabilized, see FAQ. To migrate data, use Export-Redis, delete checkpoints, upgrade server, use Import-Redis.

See also

• FarNet.Redis Release Notes
• StackExchange.Redis
• Microsoft.Garnet