FarNet.RedisKit 0.2.2

FarNet.RedisKit

Far Manager Redis helpers based on FarNet.Redis

• About
• Install
• Commands
• Keys panel
• Hash panel
• List panel
• Set panel
• Menu
• Settings

About

RedisKit is the FarNet module for Redis operations in Far Manager.

Project FarNet

• Wiki: https://github.com/nightroman/FarNet/wiki
• Site: https://github.com/nightroman/FarNet
• Author: Roman Kuzmin

Install

• Far Manager
• Package FarNet
• Package FarNet.Redis
• Package FarNet.RedisKit

How to install and update FarNet and modules
https://github.com/nightroman/FarNet#readme

Commands

RedisKit commands start with rk:. Commands are invoked in the command line or using F11 / FarNet / Invoke or defined in the user menu and file associations. Command parameters are key=value pairs using the connection string format

rk: <mask>
rk:subcommand key=value; ...

Common parameters

• redis=<configuration>

  Specifies the Redis configuration string or name.
  Default: see Settings.

Commands

• rk:

  Opens the Keys panel with the default Redis configuration and an optional key mask specified with a space after the command prefix.

• rk:edit

  Opens the string editor, see Edit string.

• rk:keys

  Opens the Keys panel.

• rk:hash

  Opens the Hash panel.

• rk:list

  Opens the List panel.

• rk:set

  Opens the Set panel.

• rk:tree

  Opens the Keys panel with the folder tree.

Edit string

This command opens the string editor

rk:edit key=<key>

Parameters

• key=<key> (required)

  Specifies the existing or new string key.

The editor is usually not modal. Saving commits the string to Redis.

Keys panel

This panel shows key folders, keys, value types and end-of-life dates. Type marks: * String, H Hash, L List, S Set.

The panel is opened by

rk: <mask>
rk:keys mask=<mask>
rk:tree root=<root>; colon=<string>

Parameters

• mask=<mask> (optional)

  Specifies the search pattern or wildcard or fixed prefix.

  (1) If the mask contains [ or ] then it is treated as Redis pattern. See: https://redis.io/docs/latest/commands/keys

  (2) If the mask contains * or ? then it is treated as wildcard with special symbols * and ? and other characters literal.

  (3) Otherwise the mask is used as the fixed literal prefix. Keys are shown without this prefix but all operations work on actual keys with the prefix.

• root=<root> (optional)

  Specifies the root key prefix for rk:tree.
  The trailing separator (colon) is optional.

• colon=<string> (optional)

  Specifies the folder separator for rk:tree.
  The default is traditional Redis colon (:).

Keys and actions

• Enter

  Opens panels for Hash, List, Set keys and key folders.
  Use Esc in order to return to the keys panel.

• F4

  Opens the cursor string value editor.

• ShiftF5

  Clones the cursor key with a new name.

• ShiftF6

  Renames the cursor key.

• F7

  Creates a new string key.

• F8, Del

  Deletes the selected keys and key folders.
  (!) Take special care on deleting folders.

• CtrlPgDn, CtrlPgUp, BS, CtrlBackSlash

  These navigation keys may be used but not recommended for rk:tree folder navigation. Consider using Enter and Esc for simple folder open / back operations.

  Enter opens the child panel and keeps the parent in the stack. Esc closes the current panel and opens the parent from the stack.

  In contrast to Enter and Esc, navigation keys do not open or close panels. They change the current panel explorer and show its new data in the same panel.

Hash panel

This panel shows hash entries, fields and values. It is opened from the keys panel or by this command:

rk:hash key=<name>

Parameters

• key=<name> (required)

  Specifies the hash key. If the key does not exist, a new hash will be created. If the key type does not match, it's an error.

Keys and actions

• F4

  Opens the cursor hash value editor.

• ShiftF5

  Clones the cursor entry.

• ShiftF6

  Renames the cursor field.

• F7

  Creates a new entry.

• F8, Del

  Deletes the selected entries.

List panel

This panel shows list items. It is opened from the keys panel or by this command:

rk:list key=<name>

Parameters

• key=<name> (required)

  Specifies the list key. If the key does not exist, a new list will be created. If the key type does not match, it's an error.

Keys and actions

• F4

  Opens the cursor item editor.

• ShiftF5

  Creates a new item before the cursor.

• ShiftF6

  Renames the item.

• F7

  Creates a new item at the tail.

• F8, Del

  Deletes the selected items.

Set panel

This panel shows set members. It is opened from the keys panel or by this command:

rk:set key=<name>

Parameters

• key=<name> (required)

  Specifies the set key. If the key does not exist, a new set will be created. If the key type does not match, it's an error.

Keys and actions

• F4

  Opens the cursor member editor.

• ShiftF5

  Creates a new member.

• ShiftF6

  Renames the member.

• F7

  Creates a new member.

• F8, Del

  Deletes the selected members.

Menu

• Help

  Shows RedisKit help.

Settings

F11 / FarNet / Settings / RedisKit Settings and Workings

Settings/Configurations

Specifies Redis configurations, environment variables are expanded. The default configuration name is specified by Workings/Configuration.

Example:

  <Configurations>
    <Configuration Name="Main">%FARNET_REDIS_CONFIGURATION%</Configuration>
    <Configuration Name="Local">127.0.0.1:3278</Configuration>
  </Configurations>

Workings/Configuration

Specifies the current default configuration name. The name must exist in Settings/Configurations.

Example:

  <Configuration>Local</Configuration>