onmode and wm arguments: Temporarily update a configuration parameter (SQL administration API)

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


Read syntax diagramSkip visual syntax diagram
>>-EXECUTE FUNCTION--+-admin-+--(------------------------------->


Element Description Key Considerations
configuration_parameter_name The name of a configuration parameter. The configuration parameter that you specify 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.


Use this function to temporarily update the value of a configuration parameter that can be dynamically updated. The new value takes effect immediately. The new value is not written to the ONCONFIG file and is lost when the database server is restarted.

This function is equivalent to the onmode -wm command.


The following example sets the value of the DYNAMIC_LOGS configuration parameter to 2 for the current session:
EXECUTE FUNCTION task("onmode","wm","DYNAMIC_LOGS=2");

Copyright© 2020 HCL Technologies Limited