FX - Parameter @ Server @ MentDB Weak
Parameter
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
parameter create|insert|add
Description
To add a new parameter
To add a new parameter
Parameters
key: The key - string - required
value: The value - integer - required
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
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)
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
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
parameter set_description <key> <description>
Description
To set the description of a parameter
To set the description of a parameter
Parameters
key: The key - string - required
description: The description - string - required
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
parameter get description <key>
Description
To get the description of a parameter
To get the description of a parameter
Parameters
key: The key - string - required
key: The key - string - required
admin
parameter get description "SERVER_NAME"
mentdb
Name of the server
parameter set_private <key> <private>
Description
To set if the value of a parameter is private (never shown in the administration)
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
key: The key - string - required
private: true or false - boolean - required
admin
parameter set_private "WEB_DOWNLOAD_TOKEN" true;
mentdb
1
parameter is_private <key>
Description
To check if the value of a parameter is private
To check if the value of a parameter is private
Parameters
key: The key - string - required
key: The key - string - required
admin
parameter is_private "WEB_DOWNLOAD_TOKEN"
mentdb
1
parameter merge <key> <value>
Description
To merge a parameter
To merge a parameter
Parameters
key: The key - string - required
value: The value - integer - required
key: The key - string - required
value: The value - integer - required
admin
parameter merge test value;
mentdb
Parameter merged with successful.
parameter exist <key>
Description
To check if a parameter exists
To check if a parameter exists
Parameters
key: The key - string - required
key: The key - string - required
admin
parameter exist test
mentdb
1
parameter get value <key>
Synonymous
get_param
get_param
Description
To get the parameter value
To get the parameter value
Parameters
key: The key - string - required
key: The key - string - required
admin
parameter get value test
mentdb
value
admin
get_param test
mentdb
value
parameter remove <key>
Description
To remove a parameter
To remove a parameter
Parameters
key: The key - string - required
key: The key - string - required
admin
parameter remove test;
mentdb
Sorry, the parameter test is locked.
parameter show
Description
To show all parameters
To show all parameters
admin
parameter show
mentdb
{ "C[basic-search]": { "locked": "1", "value": "10" }, "C[symbol]": { "locked": "1", "value": "200" }, "test": { "locked": "1", "value": "value" }, "C[relation]": { "locked": "1", "value": "200" }, "C[language]": { "locked": "1", "value": "25" }, "C[user]": { "locked": "1", "value": "25" }, "C[emotion]": { "locked": "1", "value": "25" }, "C[process-tab]": { "locked": "1", "value": "25" } }
parameter update <key> <value>
Description
To update a parameter
To update a parameter
Parameters
key: The key - string - required
value: The value - integer - required
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
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.
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
key: The key - string - required
value: The value - integer - required
admin
parameter lock_if_null test 67;
mentdb
1
parameter generate update <key>
Description
To generate a parameter update request
To generate a parameter update request
Parameters
key: The key - string - required
key: The key - string - required
admin
parameter generate update test;
mentdb
parameter update "test" "67";
admin
parameter remove test
mentdb
Parameter removed with successful.
parameter generate merge <key>
Description
To generate a merge request
To generate a merge request
Parameters
key: The key - string - required
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.