Synopsis
Updates the value and comment of a WhereScape RED metadata Parameter or creates it.
Description
Updates the value and comment of the specified parameter in the DSS_PARAMETER metadata table. If the specified parameter is not found, then it is added.
Typically, this routine is used by procedures to write information that is read by another process (automatically or manually via the RED Tools > Parameters menu item), which is external to the procedure.
Input
Input | Description |
|---|---|
Parameter Name | The case-sensitive name of the WhereScape RED metadata parameter to be updated or added. |
Parameter Value | The new value of the parameter to be assigned. Corresponds to the "Value" property that is visible and maintainable via Tools > Parameters. |
Parameter Comments | The new comments of the parameter to be assigned. Corresponds to the "Comments" property that is visible and maintainable via Tools > Parameters.The parameter comments will not be modified if a NULL value is specified. |
Output
Output | Description |
|---|---|
Result Number [SQL SERVER & ORACLE only] | Output Result Number [SQL SERVER & ORACLE only]:
|
SQL Server
SQL Server Parameters: WsParameterWrite
Callable Routine Type: PROCEDURE.
Parameter Name | Datatype | Mode |
|---|---|---|
@p_parameter | VARCHAR(64) | IN |
@p_value | VARCHAR(2000) | IN |
@p_comment | VARCHAR(256) | IN |
SQL Server Examples: WsParameterWrite
– Example 1: Result Number (procedure return code) NOT captured. EXEC WsParameterWrite 'LAST_INVOICE_ID', '123456', 'The last invoice id loaded' – Example 2: Result Number (procedure return code) captured. DECLARE @v_result_num integer EXEC @v_result_num = WsParameterWrite 'LAST_INVOICE_ID', '123456', 'The last invoice id loaded'
Teradata
Teradata Parameters: WsParameterWrite
Callable Routine Type: PROCEDURE.
Parameter Name | Datatype | Mode |
|---|---|---|
p_parameter | VARCHAR(64) | IN |
p_value | VARCHAR(2000) | IN |
p_comment | VARCHAR(256) | IN |
Teradata Examples: WsParameterWrite
CALL [METABASE].WsParameterWrite('LAST_INVOICE_ID', '123456', 'The last invoice id loaded');
Oracle
Oracle Parameters: WsParameterWrite
Callable Routine Type: FUNCTION.
Parameter Name | Datatype | Mode |
|---|---|---|
v_parameter | VARCHAR2 | IN |
v_value | VARCHAR2 | IN |
v_comment | VARCHAR2 | IN |
FUNCTION Return Value | VARCHAR2 | OUT-Function |
Oracle Examples: WsParameterWrite
v_result_num number;
v_result_num := WsParameterWrite('LAST_INVOICE_ID', '123456', 'The last invoice id loaded');
DB2
DB2 Parameters: WsParameterWrite
Callable Routine Type: PROCEDURE.
Parameter Name | Datatype | Mode |
|---|---|---|
p_parameter | VARCHAR(64) | IN |
p_value | VARCHAR(2000) | IN |
p_comment | VARCHAR(256) | IN |
DB2 Examples: WsParameterWrite
CALL [METABASE].WsParameterWrite('LAST_INVOICE_ID', '123456', 'The last invoice id loaded');