RemoveObjectList - Teradata Database - Teradata Vantage NewSQL Engine

Application Programming Reference

Product
Teradata Database
Teradata Vantage NewSQL Engine
Release Number
16.20
Published
March 2019
Language
English (United States)
Last Update
2019-05-02
dita:mapPath
vwf1492987142269.ditamap
dita:ditavalPath
changebar_rev_16_20_exclude_audience_ie.ditaval
dita:id
B035-1090
lifecycle
previous
Product Category
Teradata Vantage™

Removes a named object list and all of its entries.

Definition

REPLACE PROCEDURE TDSTATS.RemoveObjectList 
  (IN ObjectListName VARCHAR(128) CHARACTER SET UNICODE, 
   IN ObjectListId BIGINT, 
   OUT NumRemoved INTEGER)
           .
           .
           .
;

Input Parameter

Parameter Description
ObjectListName Name of the existing object list. This list may contain both databases and fully qualified tables.
This input parameter cannot be NULL.
ObjectListId ID of the existing object list to remove.
This input parameter cannot be NULL.

Usage Notes

You can view object list data in the TDSTATS.ObjectList and TDSTATS.ObjectListEntry tables. The names of the object lists are stored in the TDSTATS.ObjectList.ListName column.

Output Parameter

Parameter Description
NumRemoved Number of the database and table entries that were in the removed list.

Example: Using RemoveObjectList

The following example shows how to remove the newly created object list named FinCashList and its entries.

CALL TDSTATS.CreateObjectList('FinCashList',ObjectListId);
CALL TDSTATS.AddObjectListEntry('FinCashList',NULL,'Fin%',NULL);
CALL TDSTATS.AddObjectListEntry('FinCashList',NULL,'Account%','Cash%');
CALL TDSTATS.RemoveObjectList('FinCashList',NULL,NumRemoved);