SAS/Warehouse Administrator 2.3 Metadata API- P27 pot

SAS/Warehouse Administrator Metadata Types WHHOST 127 Overview WHHOST models the metadata for host definitions in SAS/Warehouse Administrator. A host definition is a metadata record that specifies a computer where data stores reside, where processes and jobs execute, or where process output is sent. Host definitions are included in the metadata records for data stores, processes, and scheduling server definitions in an environment. In SAS/Warehouse Administrator, to add a host definition to the current environment in the Explorer: 1 Select File Setup from the pull-down menu. 2 Select Hosts. 3 Click Add . 4 Enter the host information. Properties The following table lists all of the properties for WHHOST 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. Comamid C Yes Yes No Cvalue C Yes Yes No Desc C Yes Yes No Extended Attributes L Yes Yes Yes Icon C Yes Yes No Id C No * Req No Locale C * Req No 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 128 WHHOST Chapter 3 Operating System C Yes Yes No Processes L No No No Remote Address C Yes Yes No SAS Version C Yes Yes No Script L Yes Yes Yes Source Code L No No Yes Tables L No No No Use Script C Yes Yes No New properties for WHHOST are as follows: COMAMID indicates the SAS/CONNECT Access Method (comamid) option value that is needed to access this host. ICON specifies the catalog entry name of the associated icon. For more information about icons, see “Using Icon Information” on page 69. LOCALE indicates the location of this host. Values can be either LOCAL or REMOTE. OPERATING SYSTEM represents the operating system for this host. Valid values are defined by what is available on the Host Options tab of the Host Properties window. Some possible values are CMS, MVS, OS/2, UNIX, VMS, Windows. PROCESSES specifies an SCL list of general identifying information about the processes that execute on this host. REMOTE ADDRESS represents the remote address of this host. SAS VERSION indicates the version of SAS that is running on this host. Valid values are defined by what is available on the Host Options tab of the Host Properties window. SCRIPT specifies an SCL list of general identifying information about the SAS/CONNECT script that is associated with this host. SOURCE CODE specifies an SCL list of general identifying information about the source code that is needed to access this host. TABLES specifies an SCL list of general identifying information about the tables that reside on this host. USE SCRIPT specifies whether a SAS/CONNECT SIGNON script is used to connect to a remote host. Valid entries are NO (no script is used) or YES (a script is used). SAS/Warehouse Administrator Metadata Types WHINDEX 129 Using WHHOST Add Update Delete Yes Yes Yes WHHOST is an independent type. To understand how WHHOST relates to other types, see the host, process, and physical storage models in “Relationships Among Metadata Types” on page 53. WHINDEX Metadata type for indexes that are associated with tables and columns Category: Index Type Parent “WHROOT” on page 226 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: 1 Select a table with the right mouse button. 2 Select Properties from the pop-up menu. 3 Go to the Physical Storage tab. 4 Click Define . 5 Go to the Indexing tab. 6 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 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 130 WHINDEX Chapter 3 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. 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. SAS/Warehouse Administrator Metadata Types WHINFO 131 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: 1 Read the existing index, using _GET_METADATA_ with the all and expand parameters set to 1. 2 Change the properties as appropriate in the returned list. 3 Delete the existing index by using the _DELETE_METADATA_ method and the ID of the existing index. 4 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. WHINFO Metadata type for InfoMart items Category: Object Types—Explorer Parent “WHOBJECT” on page 182 Overview WHINFO models the metadata for information mart items (InfoMart items) in SAS/Warehouse Administrator. An InfoMart item is an object that contains or displays information that is generated from detail data or summary data in the warehouse. These items are usually SAS charts, reports, graphs, or queries. To add an InfoMart item with the SAS/Warehouse Administrator Explorer: 1 Select an information mart with the right mouse button. 2 Select Add Item Information Mart Item . SAS/Warehouse Administrator Metadata Types WHHOST 127 Overview WHHOST models the metadata for host definitions in SAS/Warehouse Administrator. A host definition is a metadata record. Among Metadata Types” on page 53. WHINDEX Metadata type for indexes that are associated with tables and columns Category: Index Type Parent “WHROOT” on page 22 6 Overview WHINDEX models the metadata. remote host. Valid entries are NO (no script is used) or YES (a script is used). SAS/Warehouse Administrator Metadata Types WHINDEX 129 Using WHHOST Add Update Delete Yes Yes Yes WHHOST is an independent