|
Elektra
0.9.3
|
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.
There are 2 types of transformations:
are applied before and after the advanced transformations.
first transformation to be applied to all keys on kdbGet.
get/case
converts the whole keyname below the parentKey to upper- or lowercase. if no configuration or unchanged is used no transformation is done here.
last transformation to be applied to all keys on kdbSet.
set/case
toupper or tolower tells the rename plugin to convert the whole keyname below the parentKey to lower or uppercase.
unchanged returns the key to its original name
keyname tells the plugin to keep the name of the advanced transformation
The cut operation can be used to strip parts of a key’s 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:
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:
The result of the cut operation would be the following KeySet:
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.
Using the /replacewith global key or rename/to MetaKey the rename plugin will replace the part removed by cut with the supplied String
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:
you can use tolower=0 to get the keys key and other/key.
``` sudo kdb mount renameTest.ini user/tests/rename mini rename get/case=toupper,set/case=keyname,/cut=REMOVED
printf 'removed/key=test' > kdb file user/tests/rename
kdb ls user/tests/rename #> user/tests/rename/KEY
kdb set user/tests/rename
cat "`kdb file user/tests/rename`" | tail -n1 #> KEY=test
kdb rm -r user/tests/rename sudo kdb umount user/tests/rename
sudo kdb mount caseconversion.ini user/tests/rename mini rename get/case=tolower,set/case=toupper
kdb set user/tests/rename/section/key value kdb get user/tests/rename/section/key #> value
cat "`kdb file user/tests/rename`" #> SECTION/KEY=value
kdb rm -r user/tests/rename sudo kdb umount user/tests/rename ```
Additional rename operations are planned for future versions of the rename plugin:
1.8.13