`configuration`¶

Show and set Refinery configuration options

refinery configuration [option]
Options:
--add-rows        --export          --list
--delete-rows     --import          --show

--list [--category cname]: List editable config parameters either all (default) or for category cname.
--show --param pname: Print out configuration parameter pname.
--export --param pname [--dir path]: Export configuration parameter pnameas a CSV to path.
--import --param pname --file fname [--do-not-validate]: Import and overwrite configuration parameter pname from CSV fname.; do-not-validate ignores validation to force import. (Watch out Incorrect format configuration may cause issues.)
--delete-rows --param pname [--indexes]: Delete from configuration parameter pname either last row (default) or indexes.
--add-rows --param pname [--do-not-validate] [--file fname | --<CONFIG_COLUMN_1> [--<CONFIG_COLUMN_2> … [--<CONFIG_COLUMN_N>]]]: Add rows to configuration parameter pname from CSV fname, or as specified with a flag per column.; do-not-validate ignores validation to force import. (Watch out Incorrect format configuration may cause issues.)

Examples¶

To see the current real-time config:

refinery configuration --show --param .daas.udf.realtimeConfig

To replace it with a new copy:

refinery configuration --import --param .daas.udf.realtimeConfig --file myNewConfig.csv

To make a parameter editable¶

To make a parameter editable (not using --do-not-validate flag) and shown by the --list command, add it to the validatedParameters.dnc.q file. This file is located at kx-refinery-cli/src/q/configuration/validatedParameters.dnc.q.

Add a line in the format (`group;`configName;`validationFunc) where

`group            category the configuration belongs to
`configName       name of the parameter within the system
`validationFunc   name of the function to validate a config

Add also a validation function in:

kx-refinery-cli/src/q/configuration/validation_group.q

Validation functions take a single argument, which is the new table, and return boolean true false for accept or reject changes.

configuration¶

Examples¶

To make a parameter editable¶

`configuration`¶