WhereScape RED callable routines provide an Application Program Interface (API) to the WhereScape RED metadata using the following SQL-invoked routines:

Routine Name

Description

Ws_Api_Glossary

Adds an entry to the documentation glossary.

Ws_Connect_Replace

Replaces the contents of a connection with details from another connection.

Ws_Job_Abort

Aborts a job if it is in a running state.

Ws_Job_Clear_Archive

Purges archived job logs that are older than the specified age in days.

Ws_Job_Clear_Logs

Archives job logs when the maximum number of current logs to retain is exceeded.

Ws_Job_Clear_Logs_By_Date

Archives job logs that are older than the specified age in days.

Ws_Job_Create

Creates a job based on an existing job and optionally starts it immediately.

Ws_Job_CreateWait

Creates a job based on an existing job and schedules it to start later.

Ws_Job_Dependency

Adds or removes a child-to-parent dependency between two jobs to control the child job.

Ws_Job_Release

Starts a job if it is a holding or waiting state.

Ws_Job_Restart

Starts a job if it is in a failed state.

Ws_Job_Schedule

Schedules a job if it is in a holding or waiting state.

Ws_Job_Status

Returns the current status of a job.

Ws_Load_Change

Changes the Connection or Schema of a load table.

Ws_Maintain_Indexes

Drops and/or builds database indexes that are defines in the WhereScape RED metadata.

Ws_Version_Clear

Purges metadata versions for all objects that do not meet the specified retention criteria.

WsParameterRead

Returns the value and comment (for most RDBMS) of a WhereScape RED metadata Parameter.

WsParameterReadF

Returns the value of a WhereScape RED metadata Parameter. [SQL Server only]

WsParameterReadG

Returns the value of a "global" WhereScape RED metadata Parameter that relates to a load table.

WsParameterWrite

Updates the value and comment of a WhereScape RED metadata Parameter or creates it.

WsWrkAudit

Records a message in the Audit Log.

WsWrkAuditBulk

Records multiple messages in the Audit Log.

WsWrkError

Records a message in the Error/Detail Log.

WsWrkErrorBulk

Records multiple messages in the Error/Detail Log.

WsWrkTask

Updates row counts for a task in the Task Log.

  • No labels