InactivateStat Syntax - Teradata VantageCloud Lake

Lake - Monitor Resources and Performance
Deployment
VantageCloud
Edition
Lake
Product
Teradata VantageCloud Lake
Release Number
Published
February 2025
ft:locale
en-US
ft:lastEdition
2025-11-21
dita:mapPath
wyu1683671641248.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
wyu1683671641248

API Definition

REPLACE PROCEDURE TDStats.InactivateStatJSON(
    IN jIn JSON(3000) CHARACTER SET UNICODE,
    OUT jOut JSON(3000) CHARACTER SET UNICODE)

JSON Keys

JSON Key IN/OUT Data Type Description
SCOID IN BIGINT AutoStats assigned unique numeric identifier for an individual statistic under automated control.
DatabaseName IN VARCHAR(128) Inactivates all statistics defined on the specified database.
TableName IN VARCHAR(128) Further limit the inactivation to the statistics defined on a specified table of DatabaseName.
ObjectListName IN VARCHAR(128) Specifies a previously defined list of objects whose statistics should be inactivated. See related API "CreateObjectList" in ObjectList APIs Syntax.
DropStat IN BOOLEAN
  • true - Statistic will be dropped from the Data Dictionary via a DROP STATISTICS statement.
  • false - Statistic will be marked inactive and will no longer be refreshed by AutoStats.

Default is true.
NumInActivated OUT INTEGER Number of statistics that were dropped or inactivated.