Elektra  0.8.15
Plugin: rename

This plugin can be used to perform rename operations on keys. This is useful if a backend does not provide keys with the required names or case.

If keys are renamed, their original name is stored in the origname MetaKey.

CUT

OPERATION

The cut operation can be used to strip parts of a keys name. The cut operation is able to cut anything below the path of the parent key. A renamed key may even replace the parent key. For example consider a KeySet with the parent key user/config. If the KeySet contained a key with the name user/config/with/long/path/key1, the cut operation would be able to strip the following key name parts:

CONFIGURATION

The cut operation takes as its only configuration parameter the key name part to strip. This configuration can be supplied in two different ways. First, the global configuration key cut can be used. Second, keys to be stripped can be tagged with the MetaKey rename/cut. If both options are given, the MetaKey takes precedence. For example, consider the following setup: 

                            `config/cut` = will/be
                            parent key = user/config

                            user/config/will/be/stripped/key1                       <- meta rename/cut = will/be/stripped
                            user/config/will/be/stripped/key2                       <- meta rename/cut = will/be/stripped
                            user/config/will/be/stripped/key3
                            user/config/will/not/be/stripped/key4

The result of the cut operation would be the following KeySet: 

                            user/config/key1
                            user/config/key2
                            user/config/stripped/key3
                            user/config/will/not/be/stripped/key4

The cut operation is agnostic to a single trailing slash in the configuration. This means that it makes no difference whether cut = will/be/stripped or cut = will/be/stripped/. However, the cut operation refuses cut paths with leading slash. This is to clarify that key name parts can only be stripped after the parent key path.

If an invalid configuration is given or the cut operation would cause a parent key duplicate, the affected keys are simply skipped and not renamed.

REPLACE

Using the /replacewith global key or rename/to MetaKey the rename plugin will replace the part removed by cut with the supplied String

TO UPPER / LOWER

Using the /toupper or /tolower global configuration key, or the rename/toupper or rename/tolower metakey the rename plugin will convert the keynames to uppercase or lowercase. The supplied values tell the plugin how many levels starting from the right will be converted. toupper and tolower can be combined. When no value or "0" is supplied with the keys the whole name below the parentkey will be converted.

The toupper/tolower conversions are applied after cut/replace.

Note that the names refer to the representation as KeySet. For example, if you have a configuration file where every name is uppercase: ``` KEY=value OTHER/KEY=otherval `` you can usetolower=0to get the keyskeyandother/key`.

EXAMPLE

``` kdb mount caseconversion.ini /rename ini rename toupper=1,tolower=3

kdb set /rename/MIXED/CASE/conversion 1

kdb ls /rename user/rename user/rename/mixed/case/CONVERSION ```

PLANNED OPERATIONS

Additional rename operations are planned for future versions of the rename plugin:

Generated by   doxygen 1.8.8