SAS/Warehouse Administrator Metadata Types

WHCOLSUM

Base metadata type for columns in summary tables and MDDBs

Category:

Column Types

Parent
Overview
Properties
Using WHCOLSUM

Parent

WHCOLUMN

Overview

WHCOLSUM is a base metadata type for all columns in summary tables and MDDBs in SAS/Warehouse Administrator.

Properties

The following table lists all of the properties for WHCOLSUM and indicates how you can use each property with metadata API methods.

In the table, you can specify properties with a Yes in the Indirect Add column when you indirectly add one object through another, as described in the documentation for the _UPDATE_METADATA_ method. Use this approach to add a new dependent object. For details, see Using _UPDATE_METADATA_.

You can pass properties with a Yes in the Update column to the _UPDATE_METADATA_ method, as described in the documentation for this method. Use this method to update properties of an existing object. For details, see Using _UPDATE_METADATA_.

* Req indicates that the property is required; you must provide a value for this property when you use a given method. * Default indicates that the system will provide a default value for that property if you do not provide one. * Auto supplied means that the property is automatically supplied; any value that you specify for such a property is ignored.

Properties with a Yes in the Read Method Expand Parm column are valid with the expand parameter of the _GET_METADATA_ method. This method enables you to get detailed metadata about a property and its associated objects through a single method call.

Properties	Type	Add Method	Update Method	Read Method Expand Parm.
Alias	C	No	No	No
Cvalue	C	No	No	No
Desc	C	No	No	No
Extended Attributes	L	No	No	Yes
Format	C	No	No	No
Id	C	No	No	No
Indexes	L	No	No	No
Informat	C	No	No	No
Input Objects	L	No	No	No
Input Sources	L	No	No	No
Length	N	No	No	No
Metadata Created	C	No	No	No
Metadata Updated	C	No	No	No
Name	C	No	No	No
Note	L	No	No	Yes
NValue	N	No	No	No
Output Objects	L	No	No	No
Output Targets	L	No	No	No
Summary Role	C	No	No	No
Table	L	No	No	No
Type	C	No	No	No

WHCOLSUM has the following two new properties:

ALIAS

specifies a character string for the column name as registered by SAS/Warehouse Administrator.

Note that the NAME for a summary column contains the physically stored name, and the ALIAS contains the name as seen through SAS/Warehouse Administrator. A column's NAME and ALIAS are the same, except for MDDB columns.

For MDDB columns, the NAME property returns the name as it would be returned through the SASSFIO libname engine when looking at a specific hierarchy. The ALIAS property returns the name as seen through SAS/Warehouse Administrator.

SUMMARY ROLE

specifies a character string for the role of the column in the summary data. For example: CLASS, STATISTIC, ID, FREQUENCY, and TIME.

Using WHCOLSUM

Add	Update	Delete
No	No	No

WHCOLSUM is a dependent type, like all subtypes of WHCOLUMN. To understand how all subtypes of WHCOLUMN relate to other types, see the column mapping models in Relationships Among Metadata Types.

Top of Page