Parameter
Manage global parameters of the server, read quickly from any script: add, update, merge, get and remove them, with a description and a private flag, and generate the request to deploy them elsewhere. Typical uses: store settings such as URLs, limits or flags.
parameter add parameter create|insert|addparameter add parameter create|insertparameter set_descriptionparameter get descriptionparameter set_privateparameter is_privateparameter mergeparameter existparameter get value get_paramparameter removeparameter showparameter updateparameter lock_if_nullparameter generate updateparameter generate merge

parameter add <key> <value>


Synonymous

    parameter create|insert|add

Description

    To add a new parameter

Parameters

    key:   The key - string - required
    value:   The value - integer - required
admin
parameter add test value;
mentdb
Parameter added with successful.

parameter add <key> <value> <description> <private>


Synonymous

    parameter create|insert

Description

    To add a new parameter with a description and a private flag (a private value is never shown in the administration)

Parameters

    key:   The key - string - required
    value:   The value - string - required
    description:   The description - string - required
    private:   true if the value is private - boolean - required
admin
parameter add "MY_API_KEY" "xyz" "Key of my API" true;
mentdb
Parameter added with successful.
admin
parameter is_private "MY_API_KEY"
mentdb
1
admin
parameter remove "MY_API_KEY";
mentdb
xyz
Used in use cases (17 recipes)

    Backend & web service developer › Publish a typed web service with its parameter and stack options
    Execution modes › Stack run postponed until a gate opens
    Web service developer › API key and limits in server parameters
    Configuration & connections › Store an API URL and a private API key as parameters
    Control flow › Same code for DEV, UAT and PROD with mode
    File transfer & remote systems engineer › Declare the partner endpoints, secrets kept in private parameters
    and 11 more in the Use cases
Often used with

    parameter remove  ·  parameter get value  ·  execute  ·  parameter update  ·  parameter exist  ·  parameter is_private  ·  cm exist  ·  cm remove

parameter set_description <key> <description>


Description

    To set the description of a parameter

Parameters

    key:   The key - string - required
    description:   The description - string - required
admin
parameter set_description "SERVER_NAME" "Name of the server";
mentdb
1
admin
parameter get description "SERVER_NAME"
mentdb
Name of the server
Used in use cases (5 recipes)

    Backend & web service developer › Publish a typed web service with its parameter and stack options
    Web service developer › API key and limits in server parameters
    Configuration & connections › Review the parameters of a project and output an audit JSON
    Automation architect › Nightly import with a cron, a file watcher and a flow
    Application developer › Feature flags of a web application
Often used with

    parameter add  ·  parameter exist  ·  parameter get value  ·  parameter generate merge  ·  parameter get description  ·  parameter is_private  ·  parameter remove  ·  parameter update

parameter get description <key>


Description

    To get the description of a parameter

Parameters

    key:   The key - string - required
admin
parameter get description "SERVER_NAME"
mentdb
Name of the server
Used in use cases (6 recipes)

    Backend & web service developer › Read server parameters and trace a run in the logs
    Web service developer › API key and limits in server parameters
    Configuration & connections › Store an API URL and a private API key as parameters
    System administrator & DevOps › Server inventory and security checks
    Application developer › Feature flags of a web application
    Configuration & connections › Review the parameters of a project and output an audit JSON
Often used with

    parameter is_private  ·  parameter exist  ·  parameter get value  ·  parameter add  ·  parameter remove  ·  parameter generate merge  ·  parameter generate update  ·  parameter set_description

parameter set_private <key> <private>


Description

    To set if the value of a parameter is private (never shown in the administration)

Parameters

    key:   The key - string - required
    private:   true or false - boolean - required
admin
parameter set_private "WEB_DOWNLOAD_TOKEN" true;
mentdb
1
Used in use cases (3 recipes)

    Backend & web service developer › Signed webhook receiver with replay protection
    Web service developer › API key and limits in server parameters
    Configuration & connections › Review the parameters of a project and output an audit JSON
Often used with

    parameter add  ·  parameter exist  ·  parameter is_private  ·  parameter remove  ·  exception  ·  execute  ·  not  ·  parameter get description

parameter is_private <key>


Description

    To check if the value of a parameter is private

Parameters

    key:   The key - string - required
admin
parameter is_private "WEB_DOWNLOAD_TOKEN"
mentdb
1
Used in use cases (8 recipes)

    Backend & web service developer › Read server parameters and trace a run in the logs
    Web service developer › API key and limits in server parameters
    Configuration & connections › Store an API URL and a private API key as parameters
    File transfer & remote systems engineer › Declare the partner endpoints, secrets kept in private parameters
    System administrator & DevOps › Server inventory and security checks
    Application developer › Feature flags of a web application
    and 2 more in the Use cases
Often used with

    parameter exist  ·  parameter get value  ·  parameter add  ·  parameter get description  ·  parameter remove  ·  execute  ·  parameter generate merge  ·  parameter generate update

parameter merge <key> <value>


Description

    To merge a parameter

Parameters

    key:   The key - string - required
    value:   The value - integer - required
admin
parameter merge test value;
mentdb
Parameter merged with successful.
Used in use cases (3 recipes)

    Configuration & connections › Generate the code that deploys your parameters to PROD
    Versioning & deployment › One deployment file: scripts and parameters
    Automation architect › Nightly import with a cron, a file watcher and a flow
Often used with

    parameter generate merge  ·  parameter remove  ·  script create  ·  bd*  ·  eval  ·  file count_lines  ·  file create  ·  file delete

parameter exist <key>


Description

    To check if a parameter exists

Parameters

    key:   The key - string - required
admin
parameter exist test
mentdb
1
Used in use cases (11 recipes)

    Backend & web service developer › Publish a typed web service with its parameter and stack options
    Web service developer › API key and limits in server parameters
    Configuration & connections › Generate the code that deploys your parameters to PROD
    Debugging & error handling › Defensive checks before calling: exists, defaults, types
    Control flow › Same code for DEV, UAT and PROD with mode
    File transfer & remote systems engineer › Declare the partner endpoints, secrets kept in private parameters
    and 5 more in the Use cases
Often used with

    parameter add  ·  parameter get value  ·  parameter is_private  ·  parameter remove  ·  execute  ·  parameter get description  ·  parameter update  ·  not

parameter get value <key>


Synonymous

    get_param

Description

    To get the parameter value

Parameters

    key:   The key - string - required
admin
parameter get value test
mentdb
value
admin
get_param test
mentdb
value
Used in use cases (29 recipes)

    Backend & web service developer › Publish a typed web service with its parameter and stack options
    Execution modes › Stack run postponed until a gate opens
    Web service developer › API key and limits in server parameters
    Configuration & connections › Store an API URL and a private API key as parameters
    Control flow › Same code for DEV, UAT and PROD with mode
    File transfer & remote systems engineer › Declare the partner endpoints, secrets kept in private parameters
    and 23 more in the Use cases
Often used with

    execute  ·  parameter add  ·  parameter remove  ·  cm get  ·  parameter exist  ·  parameter update  ·  json doc  ·  not

parameter remove <key>


Description

    To remove a parameter

Parameters

    key:   The key - string - required
admin
parameter remove test;
mentdb
Sorry, the parameter test is locked.
Used in use cases (16 recipes)

    Backend & web service developer › Signed webhook receiver with replay protection
    Execution modes › Stack run postponed until a gate opens
    Web service developer › API key and limits in server parameters
    Configuration & connections › Store an API URL and a private API key as parameters
    Versioning & deployment › One deployment file: scripts and parameters
    Control flow › Same code for DEV, UAT and PROD with mode
    and 10 more in the Use cases
Often used with

    parameter add  ·  parameter get value  ·  parameter update  ·  execute  ·  parameter exist  ·  parameter is_private  ·  cm remove  ·  script create

parameter show


Description

    To show all parameters

admin
parameter show
mentdb
{ "SERVER_MODE": { "locked": "1", "value": "DEV" }, "test": { "locked": "1", "value": "value" }, "REST_CONNECT_TIMEOUT": { "locked": "1", "value": "10000" } }
Used in use cases (1 recipe)

    Configuration & connections › Review the parameters of a project and output an audit JSON
Often used with

    atom get  ·  atom size  ·  json doc  ·  json iobject  ·  parameter add  ·  parameter exist  ·  parameter get description  ·  parameter is_private

parameter update <key> <value>


Description

    To update a parameter

Parameters

    key:   The key - string - required
    value:   The value - integer - required
admin
parameter update test 67;
mentdb
Parameter updated with successful.
admin
parameter get value test
mentdb
67
Used in use cases (10 recipes)

    Backend & web service developer › Publish a typed web service with its parameter and stack options
    Execution modes › Stack run postponed until a gate opens
    Web service developer › API key and limits in server parameters
    Configuration & connections › Generate the code that deploys your parameters to PROD
    Control flow › Same code for DEV, UAT and PROD with mode
    Integrator & ETL developer › Incremental sync between two databases with a watermark
    and 4 more in the Use cases
Often used with

    parameter add  ·  parameter get value  ·  parameter remove  ·  parameter exist  ·  not  ·  script create  ·  exception  ·  execute

parameter lock_if_null <key> <value>


Description

    To lock a parameter if the parameter is null. Returns 0 if it is already locked, 1 if the parameter has been locked.

Parameters

    key:   The key - string - required
    value:   The value - integer - required
admin
parameter lock_if_null test 67;
mentdb
1
Used in use cases (1 recipe)

    Configuration & connections › Make sure a batch never runs twice at the same time
Often used with

    exception  ·  parameter add  ·  parameter remove  ·  parameter update  ·  sid  ·  string regexp_extract  ·  string regexp_replace  ·  try

parameter generate update <key>


Description

    To generate a parameter update request

Parameters

    key:   The key - string - required
admin
parameter generate update test;
mentdb
parameter update "test" "67";
admin
parameter remove test
mentdb
Parameter removed with successful.
Used in use cases (4 recipes)

    Backend & web service developer › Read server parameters and trace a run in the logs
    Web service developer › API key and limits in server parameters
    Configuration & connections › Generate the code that deploys your parameters to PROD
    System administrator & DevOps › Server inventory and security checks
Often used with

    parameter exist  ·  parameter generate merge  ·  parameter get description  ·  parameter get value  ·  parameter is_private  ·  parameter add  ·  parameter remove  ·  parameter update

parameter generate merge <key>


Description

    To generate a merge request

Parameters

    key:   The key - string - required
admin
parameter generate merge test;
mentdb
parameter merge "test" "67" false;
admin
parameter remove test
mentdb
Parameter removed with successful.
Used in use cases (6 recipes)

    Backend & web service developer › Read server parameters and trace a run in the logs
    Web service developer › API key and limits in server parameters
    Configuration & connections › Generate the code that deploys your parameters to PROD
    Versioning & deployment › One deployment file: scripts and parameters
    Automation architect › Nightly import with a cron, a file watcher and a flow
    Application developer › Feature flags of a web application
Often used with

    parameter exist  ·  parameter get value  ·  parameter remove  ·  parameter add  ·  parameter generate update  ·  parameter get description  ·  parameter is_private  ·  parameter merge