SAS/Warehouse Administrator 2.3 Metadata API- P17 doc

SAS/Warehouse Administrator Metadata Types WHCOLODD 77 NValue N Yes Yes No Output Objects L No No No Output Targets L Yes Yes No Table L * Auto supplied No No Type C * Req * Req No Using WHCOLDTL Add Update Delete No Yes Yes WHCOLDTL 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” on page 53. WHCOLODD Metadata type for ODD columns Category: Column Types Parent “WHCOLUMN” on page 87 Overview WHCOLODD models the metadata for operational data definition (ODD) table columns in SAS/Warehouse Administrator. To display these columns with the SAS/Warehouse Administrator Explorer: 1 Select an ODD with the right mouse button. 2 Select Properties from the pop-up menu. 3 Go to the Columns tab. Properties The following table lists all of the properties for WHCOLODD and indicates how you can use each property with metadata API methods. In the table, you can specify properties with a Ye s 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_” on page 46. 78 WHCOLODD Chapter 3 You can pass properties with a Ye s 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_” on page 46. * 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 Ye s 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. Cvalue C Yes Yes No Desc C Yes Yes No Extended Attributes L Yes Yes Yes Format C Yes Yes Yes Id C * Req Yes No Indexes L No No No Informat C Yes Yes No Input Objects L No No No Input Sources L Yes Yes No Length N Yes Yes No Metadata Created C No No No Metadata Updated C No No No Name C * Default Yes No Note L Yes Yes Yes NValue N Yes Yes No Output Objects L No No No Output Targets L Yes Yes No Table L * Auto supplied No No Type C * Req * Req No Using WHCOLODD Add Update Delete No Yes Yes SAS/Warehouse Administrator Metadata Types WHCOLOLP 79 WHCOLODD 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” on page 53. WHCOLOLP Metadata type for OLAP columns Category: Column Types Parent “WHCOLUMN” on page 87 Overview WHCOLOLP replaces the WHCOLSUM metadata type from Release 1.3. WHCOLOLP models the metadata for OLAP tables, Groups, and MDDBs in the SAS/Warehouse Administrator. Properties The following table lists all of the properties for WHCOLOLP and indicates how you can use each property with metadata API methods. In the table, you can pass properties with a Ye s in the Add column to the _ADD_METADATA_ method. Use this method to add a new object. You can pass properties with a Ye s in the Update column to the _UPDATE_METADATA_ method. Use this method to update properties of an existing object. * 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. Properties with a Ye s 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. Crossings L No No Yes Cvalue C No Yes No Desc C No Yes No Extended Attributes L No Yes Yes Hierarchies L No No No Format C No Yes No Id C No * Req No Indexes L No No No 80 WHCOLOLP Chapter 3 Informat C No Yes No Input Objects L No No No Input Sources L No No No Length N No Yes No Metadata Created C No No No Metadata Updated C No No No Name C No * Default No Note L No Yes Yes NValue N No Yes No Output Objects L No No No Output Targets L No No No Statistic C No Yes No Sort Order C No Yes No Summary Role C No Yes No Table L No No No Type C No Yes No New properties for WHCOLOLP are as follows: CROSSINGS specifies an SCL list of general identifying information about the crossings that are associated with an OLAP group, Table, or MDDB. HIERARCHIES specifies an SCL list of general information about the hierarchies that are associated with an OLAP group, Table, or MDDB. SORT ORDER specifies a character string that contains the sort order of the column. Valid values are ASCENDING, DESCENDING, ASCFORMATTED, DESFORMATTED, and DSORDER. STATISTIC specifies a character string that contains the name of the statistic used to compute this statistic column. SUMMARY ROLE specifies a character string that contains the role of the column in the summary data. Valid values are CLASS, STATISTIC, ID, and _TYPE_. Using WHCOLOLP Add Update Delete No Yes Yes WHCOLOLP is a dependent type, like its parent, WHCOLUMN. To understand how all the subtypes of WHCOLOLP relate to other types, see the OLAP Metadata Type Model in “Relationships Among Metadata Types” on page 53. SAS/Warehouse Administrator Metadata Types WHCOLSCL 81 WHCOLSCL Metadata type for statistic columns in summary tables and MDDBs Category: Column Types Parent “WHCOLSUM” on page 83 Overview WHCOLSCL models the metadata for statistic columns in summary tables and MDDBs in SAS/Warehouse Administrator. To display these columns with the SAS/Warehouse Administrator Explorer: 1 Select a summary group with the right mouse button. 2 Select Properties from the pop-up menu. 3 Go to the Column Roles tab. The statistic columns in a summary group are shared by all summary tables and MDDBs in the group. Properties The following table lists all of the properties for WHCOLSCL and indicates how you can use each property with metadata API methods. In the table, you can specify properties with a Ye s 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_” on page 46. You can pass properties with a Ye s 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_” on page 46. * 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 Ye s 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. Alias C No No No Cvalue C No No No Desc C No No No Extended Attributes LNoNo Yes . to other types, see the OLAP Metadata Type Model in “Relationships Among Metadata Types” on page 53. SAS/Warehouse Administrator Metadata Types WHCOLSCL 81 WHCOLSCL Metadata type for statistic. columns in SAS/Warehouse Administrator. To display these columns with the SAS/Warehouse Administrator Explorer: 1 Select an ODD with the right mouse button. 2 Select Properties from the pop-up menu. 3. Types Parent “WHCOLSUM” on page 83 Overview WHCOLSCL models the metadata for statistic columns in summary tables and MDDBs in SAS/Warehouse Administrator. To display these columns with the SAS/Warehouse Administrator