Synopsis
Purges metadata versions for all objects that do not meet the specified retention criteria.
Description
Deletes metadata versions for all objects that do not meet the specified retention criteria, which can be specified as the minimum number of versions to retain per object and/or the maximum age (in days) of versions to retain. For example, it is possible to specify that a minimum of 5 versions are retained for each object and/or that versions are retained for a maximum of 90 days.
Input

Input

Description

Common Input

Includes all 5 inputs of the Callable Routines Common Input.

Maximum Days to Retain

The maximum age (in days) of the versions to retain. If 90 days are retained, then all the versions that are older than 90 days are purged/deleted to reduce the number of versions to the specified maximum number of versions per object. If not specified, then the retention date of each version determines whether it is deleted.

Minimum Versions per Object to Retain

The minimum number of versions to retain for each object. If 5 is specified, then the last 5 versions are retained per object regardless of the specified maximum age to retain.

Options

Currently NOT used.

Output

Output

Description

Return Code

Output Return Code:

  • S Success.
  • E Error.
  • F Fatal/Unexpected Error.

Return Message

Output message indicating the action applied or the reason for no action.

Result Number  

Output Result Number:

  • 1 Success.
  • -2 Error.
  • -3 Fatal/Unexpected Error.

SQL Server

SQL Server Parameters: Ws_Version_Clear
Callable Routine Type: PROCEDURE.

Parameter Name

Datatype

Mode

@p_sequence

INTEGER

IN

@p_job_name

VARCHAR(64)

IN

@p_task_name

VARCHAR(64)

IN

@p_job_id

INTEGER

IN

@p_task_id

INTEGER

IN

@p_day_count

INTEGER

IN

@p_keep_count

INTEGER

IN

@p_options

VARCHAR(256)

IN

@p_return_code

VARCHAR(1)

OUT

@p_return_msg

VARCHAR(256)

OUT

@p_result

INTEGER

OUT

SQL Server Examples: Ws_Version_Clear

– The p_ VARIABLES are normally PARAMETERS in a RED-generated Procedure.
DECLARE @p_sequence integer
DECLARE @p_job_name varchar(256)
DECLARE @p_task_name varchar(256)
DECLARE @p_job_id integer
DECLARE @p_task_id integer
DECLARE @p_return_msg varchar(256)
DECLARE @p_status integer
DECLARE @v_result_num integer
DECLARE @v_return_code varchar(1)
DECLARE @v_return_msg varchar(256)
EXEC Ws_Version_Clear
@p_sequence, @p_job_name, @p_task_name, @p_job_id, @p_task_id
, 90, 5, NULL
, @v_return_code OUTPUT
, @v_return_msg OUTPUT
, @v_result_num OUTPUT

Teradata

Teradata Parameters: Ws_Version_Clear
Callable Routine Type: PROCEDURE.

Parameter Name

Datatype

Mode

p_sequence

INTEGER

IN

p_job_name

VARCHAR(64)

IN

p_task_name

VARCHAR(64)

IN

p_job_id

INTEGER

IN

p_task_id

INTEGER

IN

p_day_count

INTEGER

IN

p_keep_count

INTEGER

IN

p_options

VARCHAR(256)

IN

p_return_code

VARCHAR(1)

OUT

p_return_msg

VARCHAR(256)

OUT

p_result

INTEGER

OUT

Teradata Examples: Ws_Version_Clear

– The p_ VARIABLES are normally PARAMETERS in a RED-generated Procedure.
DECLARE p_sequence integer;
DECLARE p_job_name varchar(256);
DECLARE p_task_name varchar(256);
DECLARE p_job_id integer;
DECLARE p_task_id integer;
DECLARE p_return_msg varchar(256);
DECLARE p_status integer;
DECLARE v_result_num integer;
DECLARE v_return_code varchar(1);
DECLARE v_return_msg varchar(256);
CALL [METABASE].Ws_Version_Clear
( p_sequence, p_job_name, p_task_name, p_job_id, p_task_id
, 90, 5, NULL
, v_return_code
, v_return_msg
, v_result_num
);

Oracle

Oracle Parameters: Ws_Version_Clear
Callable Routine Type: FUNCTION.

Parameter Name

Datatype

Mode

p_sequence

NUMBER

IN

p_job_name

VARCHAR2

IN

p_task_name

VARCHAR2

IN

p_job_id

NUMBER

IN

p_task_id

NUMBER

IN

p_day_count

NUMBER

IN

p_keep_count

NUMBER

IN

p_options

VARCHAR2

IN

p_return_code

VARCHAR2

OUT

p_return_msg

VARCHAR2

OUT

FUNCTION Return Value

NUMBER

OUT-Function

Oracle Examples: Ws_Version_Clear

– The p_ VARIABLES are normally PARAMETERS in a RED-generated Procedure.
p_sequence number;
p_job_name varchar2(256);
p_task_name varchar2(256);
p_job_id number;
p_task_id number;
p_return_msg varchar2(256);
p_status number;
v_result_num number;
v_return_code varchar2(1);
v_return_msg varchar2(256);
v_result_num := Ws_Version_Clear
( p_sequence, p_job_name, p_task_name, p_job_id, p_task_id
, 90, 5, NULL
, v_return_code
, v_return_msg
);

DB2

DB2 Parameters: Ws_Version_Clear
Callable Routine Type: PROCEDURE.

Parameter Name

Datatype

Mode

p_sequence

INTEGER

IN

p_job_name

VARCHAR(64)

IN

p_task_name

VARCHAR(64)

IN

p_job_id

INTEGER

IN

p_task_id

INTEGER

IN

p_day_count

INTEGER

IN

p_keep_count

INTEGER

IN

p_options

VARCHAR(256)

IN

p_return_code

VARCHAR(1)

OUT

p_return_msg

VARCHAR(256)

OUT

p_result

INTEGER

OUT

DB2 Examples: Ws_Version_Clear

– The p_ VARIABLES are normally PARAMETERS in a RED-generated Procedure.
DECLARE p_sequence integer;
DECLARE p_job_name varchar(256);
DECLARE p_task_name varchar(256);
DECLARE p_job_id integer;
DECLARE p_task_id integer;
DECLARE p_return_msg varchar(256);
DECLARE p_status integer;
DECLARE v_result_num integer;
DECLARE v_return_code varchar(1);
DECLARE v_return_msg varchar(256);
CALL [METABASE].Ws_Version_Clear
( p_sequence, p_job_name, p_task_name, p_job_id, p_task_id
, 90, 5, NULL
, v_return_code
, v_return_msg
, v_result_num
);


  • No labels