SAS/Warehouse Administrator Metadata Types

WHINDEX

Metadata type for indexes that are associated with tables and columns

Category:

Index Type

Parent
Overview
Properties
Using WHINDEX

Parent

WHROOT

Overview

WHINDEX models the metadata for SAS indexes that are associated with tables and columns in SAS/Warehouse Administrator. The tables can be in SAS or DBMS format. To specify a SAS index for a table in the SAS/Warehouse Administrator Explorer:

Select a table with the right mouse button.
Select Properties from the pop-up menu.
Go to the Physical Storage tab.
Click Define.
Go to the Indexing tab.
Enter the index information.

Properties

The following table lists all of the properties for WHINDEX 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	Indirect Add	Update Method	Read Method Expand Parm.
Clustered	N	* Default	No	No
Columns	L	Yes	No	No
Cvalue	C	Yes	No	No
Desc	C	Yes	No	No
Extended Attributes	L	Yes	No	Yes
Host	L	Yes	Yes	No
Id	C	* Req	No	No
Metadata Created	C	* Auto supplied	No	No
Metadata Updated	C	* Auto supplied	No	No
Name	C	* Req	No	No
Note	L	Yes	No	Yes
NValue	N	Yes	No	No
Options	L	Yes	No	No
Physical Storage	L	* Auto supplied	No	No
Unique	N	* Default	No	No

New properties for WHINDEX are as follows:

CLUSTERED: specifies a numeric value (0 for No, 1 for Yes) that indicates whether this index is clustered.
COLUMNS: specifies an SCL list of general identifying information about the columns that are involved in this index.
OPTIONS: indicates an SCL list of character strings that contains any options that are entered by the user.
PHYSICAL STORAGE: specifies an SCL list of general identifying information about the physical storage definition to which this index is associated.
UNIQUE: specifies a numeric value (0 for No, 1 for Yes) that indicates whether this index is a unique index.

Using WHINDEX

Add	Update	Delete
No	No	Yes

To update a WHINDEX:

Read the existing index, using _GET_METADATA_ with the all and expand parameters set to 1.
Change the properties as appropriate in the returned list.
Delete the existing index by using the _DELETE_METADATA_ method and the ID of the existing index.
Issue an _UPDATE_METADATA_ call to the associated physical storage object, such as the WHINDEX PHYSICAL STORAGE property contents. In the passed l_meta list, include the INDEXES property, which has a sublist of the copied WHINDEX metadata list.

WHINDEX is a dependent type. It is dependent on a physical storage definition, such as a subtype of WHPHYSTR.

Top of Page