onmode and wf arguments: Permanently update a configuration parameter (SQL administration API)

Use the onmode and wf arguments with the admin() or task() function to dynamically update the value of a configuration parameter in the onconfig file.

Syntax


1  EXECUTE FUNCTION
1 admin
1 task
2  (
2  "onmode" , "wf" , "configuration_parameter_name=new_value" ) ;
Element Description Key Considerations
configuration_parameter_name The name of a configuration parameter. The configuration parameter must be one that you can update dynamically.

The list of configuration parameters that you can update dynamically is the same as for the onmode -wf command.
new_value The new value or values for the configuration parameter. The value must be valid for the configuration parameter.

The format of the new value must conform exactly to the syntax for that configuration parameter.

Usage

Use this function to permanently update the value of a configuration parameter. The new value takes effect immediately and persists in the ONCONFIG file after the server restarts.

This function is equivalent to the onmode -wf command.

Example

The following example sets the value of the DYNAMIC_LOGS configuration parameter to 2 in the onconfig file:
EXECUTE FUNCTION task("onmode","wf","DYNAMIC_LOGS=2");