16.20 - PrioritizePreparedCollect - Teradata Vantage NewSQL Engine

Teradata Vantage™ Application Programming Reference

prodname
Teradata Database
Teradata Vantage NewSQL Engine
vrm_release
16.20
created_date
March 2019
category
Programming Reference
featnum
B035-1090-162K

Changes the submission order of an individual collection within a prepared commands list.

Definition

REPLACE PROCEDURE TDSTATS.PrioritizePreparedCollect
  (IN RequestID    BIGINT,
   IN Priority     INTEGER,
   OUT NumUpdated  INTEGER)
           .
           .
           .
;

Input Parameters

Parameter Description
RequestID TDSTATS database unique ID for an individual prepared collection.
This input parameter cannot be NULL.
Priority Changed priority of the specified collection expressed as a relative rank among other collections in the commands list containing RequestID.
This input parameter cannot be NULL.

Usage Notes

You can call the SelectPreparedCollects external stored procedure to determine the priority of other collections in the same commands list.

The modified priority is only relevant to the commands list containing the specified collection as identified by RequestID. Future invocations of PrepCollect will not incorporate the modified priority.

If two or more collections have the same priority within a commands list, the submission order among them is undefined.

Output Parameter

Parameter Description
NumUpdated Possible values:
  • 1 means the operation was successful.
  • 0 means the operation failed.

Example: Using PrioritizePreparedCollect

The following example shows how to change the priority of pending collection number from 12 to 1 (that is, one being the highest priority).

CALL TDSTATS.PrioritizePreparedCollect(12, 1, NumUpdated);
*** Procedure has been executed.
*** Total elapsed time was 1 second.
 NumUpdated
-----------
          1

Related Topics

For more information on ... See ...
the priority of other collections in the commands list SelectPreparedCollects.
preparing a prioritize list of COLLECT STATISITICS statements PrepCollect.