refinery-configuration(8) -- configuration parameter management¶

Synopsis¶

refinery configuration [option]

Description¶

Functionality to manage configuration of the system

Options¶

    --list                      List editable config parameters
        [--category]            Only display config parameters of a specified category

    --show                      Print out configuration parameter
        --param                 Configuration parameter name

    --export                    Export the configuration parameter to .csv
        --param                 Configuration parameter name
        [--dir]                 Output to specified location

    --import                    Import and overwrite configuration parameter with new file
        --param                 Configuration parameter name
        --file                  Specified .csv file
        [--do-not-validate]     Ignore validation to force import (WARNING: INCORRECT FORMAT CONFIGURATION MAY CAUSE ISSUES)

    --delete-rows               Deletes the last row of the configuration parameter
        --param                 Configuration parameter name
        [--index]               Deletes specified indicies

    --add-rows                  Adds rows to configuration parameter
        --param                 Configuration parameter name
        [--file]                Loads rows from specified .csv file
        [--<CONFIG_COLUMN_1>]
        [--<CONFIG_COLUMN_2>]
        [...            ]
        [--<CONFIG_COLUMN_N>]   For configuration not loaded from file, arguments must be specified with a flag per column
        [--do-not-validate]     Ignore validation to force import (WARNING: INCORRECT FORMAT CONFIGURATION MAY CAUSE ISSUES)

Developer information¶

To enable a parameter to be editable (not using --do-not-validate flag) and appear in the --list command, you must add it to the validatedParameters.dnc.q file. This file is located at kx-refinery-cli/src/q/configuration/validatedParameters.dnc.q.

A line must be added in the format:

(`group; `configName; `validationFunc)

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

A validation function must also be added in kx-refinery-cli/src/q/configuration/validation_<group>.q. These functions take a single argument which is the new table, and must output boolean true false for accept or reject changes.

Copyright¶

Version¶

RELEASE_NAME