Plugin: enum

• infos = Information about the enum plugin is in keys below
• infos/author = Thomas Waser thoma.nosp@m.s.wa.nosp@m.ser@l.nosp@m.ibel.nosp@m.ektra.nosp@m..org
• infos/licence = BSD
• infos/provides = check
• infos/needs =
• infos/recommends =
• infos/placements = presetstorage
• infos/status = productive maintained unittest tested nodep libc
• infos/metadata = check/enum check/enum/# check/enum/multi
• infos/description = validates values against enum

The enum plugin checks string values of Keys by comparing it against a list of valid values.

Usage

The plugin checks every Key in the Keyset for the Metakey check/enum containing a list with the syntax `'string1', 'string2', 'string3', ..., 'stringN'` and compares each value with the string value of the Key. If no match is found an error is returned.

Alternatively, if check/enum starts with #, a meta array check/enum is used. For example:

check/enum = #3
check/enum/#0 = small
check/enum/#1 = middle
check/enum/#2 = large
check/enum/#3 = huge

Furthermore check/enum/multi may contain a separator character, that separates multiple allowed occurrences. For example:

check/enum/multi = _

Then the value middle_small would validate. But middle_small_small would fail because every entry might only occur once.

## Example ##

# Backup-and-Restore:/examples/enum
sudo kdb mount enum.ecf /examples/enum enum dump
#
# valid initial value + setup valid enum list
#
kdb set /examples/enum/value middle
kdb setmeta user/examples/enum/value check/enum "'low', 'middle', 'high'"
#
# should succeed
#
kdb set /examples/enum/value low
#
# should fail with error 121
#
kdb set /examples/enum/value no
# RET:5
# ERRORS:121
# The command set failed while accessing the key database with the info:
# Error (#121) occurred!
# Description: Validation failed
# Ingroup: plugin
# Module: enum
#
# cleanup
#
kdb rm -r /examples/enum
sudo kdb umount /examples/enum

Or with multi-enums:

# Backup-and-Restore:/examples/enum
sudo kdb mount enum.ecf /examples/enum enum dump
#
# valid initial value + setup array with valid enums
#
kdb set /examples/enum/value middle_small
kdb setmeta user/examples/enum/value check/enum/#0 small
kdb setmeta user/examples/enum/value check/enum/#1 middle
kdb setmeta user/examples/enum/value check/enum/#2 large
kdb setmeta user/examples/enum/value check/enum/#3 huge
kdb setmeta user/examples/enum/value check/enum/multi _
kdb setmeta user/examples/enum/value check/enum "#3"
#
# should succeed
#
kdb set /examples/enum/value ___small_middle__
#
# should fail with error 121
#
kdb set /examples/enum/value ___all_small__
# RET:5
# ERRORS:121
# The command set failed while accessing the key database with the info:
# Error (#121) occurred!
# Description: Validation failed
# Ingroup: plugin
# Module: enum
#
# cleanup
#
kdb rm -r /examples/enum
sudo kdb umount /examples/enum