SYSLIB.SparseMapAMPs Function | SQL Operators & UDFs | Teradata Vantage - SYSLIB.SparseMapAMPs - Advanced SQL Engine - Teradata Database

SYSLIB.SparseMapAMPs is a table function that returns the AMPs with a sparse map defined for a table, join index, or hash index.

The view DBC.SparseMapAMPsV is an alternative to using the table function SYSLIB.SparseMapAMPs. The underlying system view, DBC.ObjectsInSparseMapsV, prepares all arguments for the table function. See Teradata Vantage™ - Data Dictionary, B035-1092 for more details about views DBC.SparseMapAMPsV and DBC.ObjectsInSparseMapsV.

ANSI Compliance

This statement is a Teradata extension to the ANSI SQL:2011 standard.

Syntax

[SYSLIB.] SparseMapAMPs (
  'DatabaseName',
  'ObjectName',
  'ObjectKind',
  'MapSlot',
  'NumberOfPrimaryAmps',
  'ColocationName'
)

Syntax Elements

SYSLIB.

Name of the database where the function is located.

DatabaseName

The database in which the object is defined.

ObjectName

Name of the table, join index, or hash index defined in DatabaseName. It cannot be NULL.

ObjectKind

The kind of objects, such as a table, join index or hash index, defined in the sparse map.

MapSlot

The map slot of the sparse map.

If the map containing the map slot does not exist, or is not a sparse map, an error is returned.

NumberOfPrimaryAMPs

The number of primary AMPs defined in the sparse map.

ColocationName

The colocation name string for the table.