Creating Object Lists | Application Programing Reference | Teradata Vantage - Creating Object Lists - Teradata Vantage - Analytics Database

Application Programming Reference

Deployment
VantageCloud
VantageCore
Edition
VMware
Enterprise
IntelliFlex
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
ft:locale
en-US
ft:lastEdition
2025-11-21
dita:mapPath
qld1628112131956.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
ajo1472244909562
lifecycle
latest
Product Category
Teradata Vantageā„¢

There are some situations where the desired scope for an Automate, Analyze, or Collect API call involves a list of objects that cannot be specified by the DatabaseName and TableName or ObjectName input parameters even with the use of wildcard characters (see AddQueryListEntry)

To solve this problem, you can create object lists that are capable of representing one or more database names or fully qualified table names where each name entry may optionally contain wildcard characters that are dynamically resolved at the time of API invocation.

You can use these open APIs to create a named object list that represents any arbitrary set of database or tables. The named object list can be passed to an Automate, Analyzer, or a Collect-related open API.

Functionality

If you want to ... Use the following SQL interface ...
create a new object list with a user specified name CreateObjectList.
add a database or table name to an existing named object list AddObjectListEntry.
remove a list and the object entries within it RemoveObjectList.
display the database and table objects contained within a specified object list SelectFromObjectList.