What is the SAS/Warehouse Administrator Metadata API?
What Can I Do with the SAS/Warehouse Administrator Metadata API?
How the Metadata API Works
Identifying Metadata
Reading Metadata: A Simple Example
Metadata Repositories
Setting the Active Metadata Repository
Learning to Use the Metadata API
Naming Conventions Used in This Manual
Where Metadata API Classes and SLISTS are Stored
Metadata API Class
Overview of the Metadata API Class
Using the Metadata API Class
Introduction to Metadata API Methods
Conventions
Error Codes
Metadata Property List
Index to Metadata API Methods
SAS/Warehouse Administrator Metadata Types
Overview of SAS/Warehouse Administrator Metadata Types
What Is a Metadata Type?
Metadata Repository Types
Metadata Type Inheritance
Using Metadata Types
Relationships Among Metadata Types
Writing Metadata
Overview of the Process Editor
Reading Process Flow Metadata
Input Tables, Output Tables, and Job Metadata
Reading Job Metadata
Reading Job Flow Metadata
Reading Job Hierarchy Metadata
Using Icon Information
Index to SAS/Warehouse Administrator Metadata Types
Using the Metadata Type Dictionary
General Identifying Information
Sample Metadata API Code
Appendix Overview
Read Metadata Code Sample
Write Metadata Code Sample
Metadata Type Inheritance Tree
SAS/Warehouse Administrator Metadata Type Inheritance Tree
Recommended Reading
Recommended Reading
Glossary
Index
Nội dung
SAS/Warehouse Administrator Metadata Types WHPRCLDR 207 PROCESS GROUPS specifies an SCL list of general identifying information about the process groups to which this object belongs. This list must be of type WHDW, WHDWENV, WHGRPJOB, or a subtype of those. A process object cannot be a member of more than one PROCESS GROUP. At least one group is required. PROCESS MEMBERS specifies an SCL list of general identifying information about the process members that belong to this object. Using WHPOBJCT Add Update Delete No No No WHPOBJCT is an independent type. WHPOBJCT is not used to read or write metadata in a repository. WHPRCLDR Base metadata type for table load processes Category: Process Types—Load Parent “WHPRCMAN” on page 209 Overview WHPRCLDR is the base metadata type for table load processes in the SAS/Warehouse Administrator Process Editor. Properties The following table lists all of the properties for WHPRCLDR 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. 208 WHPRCLDR Chapter 3 Properties Type Add Method Update Method Read Method Expand Parm. Administrator L No No No Cvalue C No No No Desc C No No No Extended Attributes LNoNo Yes Host L No No No Id C No No No Load Options L 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 Tables L No No No Owner L No No No Responsibility C No No No Source Code L No No Yes Source File L No No Yes Step Source Code L No No Yes Subprocesses L No No Yes WHPRCLDR has the following new property: LOAD OPTIONS specifies an SCL list of options for the specified load process. The options are as follows: GENERATION LEVEL (1.1 or 2.0) selects the release level of the code that SAS/Warehouse Administrator will generate for the specified load process. Each level has specific options that it can support, as well as other characteristics. LOAD TIME COLUMN (YES or NO) indicates whether a Load Time column will be added to the table that is being loaded by the specified process. Note: See Property Dependencies. DROP INDEXES (YES or NO) specifies that you should drop (remove) any existing indexes on the table to be loaded before you load the data into the table. Based on the metadata definitions, the appropriate indexes will be recreated after loading the data. This option is useful when updating the indexes during loading is too slow. TRUNCATE TABLE (YES or NO) specifies that when you refresh the data in a table, the table should be truncated (all data rows are removed but the table is not) instead of completely dropping the table and recreating it from scratch. This option is useful when the table has many options, privileges, and other characteristics that are defined in the database. SAS/Warehouse Administrator Metadata Types WHPRCMAN 209 UNION MULTIPLE INPUTS (YES or NO) specifies that any multiple inputs to the current load process will be unioned together before you load the table. A union is identical to a SET statement in a SAS data step that contains multiple input table designations. In the SAS/Warehouse Administrator interface, LOAD OPTIONS are specified on the Load Options tab of the Load process attributes window for a given data store. Here are some example return values for a data store whose Load process attributes window includes a Load Options tab: LOAD OPTIONS=( GENERATION LEVEL=’2.0’ LOAD TIME COLUMN=’NO’ UNION MULTIPLE INPUTS=’YES’ DROP INDEXES=’NO’ TRUNCATE TABLE=’NO’ ) Property Dependencies Subtypes of WHPRCLDR enable you to add or update the LOAD OPTIONS property. When you add or update the LOAD OPTIONS property, if the value of the LOAD TIME COLUMN item is YES, then a valid load time column must exist for the table that is associated with this load process to avoid errors when processing the SOURCE CODE and STEP SOURCE CODE properties. You can add a load time column to a table as described in the documentation for the WHCOLTIM type. Using WHPRCLDR Add Update Delete No No No WHPRCLDR is a dependent type. To understand how all subtypes of WHPROCES relate to other types, see the process models in “Relationships Among Metadata Types” on page 53. For details about reading process information, see “Reading Process Flow Metadata” on page 62. WHPRCMAN Base metadata type for main processes Category: Process Types Parent “WHPROCES” on page 223 210 WHPRCMAN Chapter 3 Overview WHPRCMAN is one of the base types for main processes in the SAS/Warehouse Administrator Process Editor. It is the parent of WHPRCLDR, the base type for all load process metadata. Properties The following table lists all of the properties for WHPRCMAN 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. Administrator L No No No Cvalue C No No No Desc C No No No Extended Attributes LNoNo Yes Host L No No No Id C 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 Tables L No No No Owner L No No No Responsibility C No No No Source Code L No No Yes Source File L No No Yes Step Source Code L No No Yes Subprocesses L No No Yes SAS/Warehouse Administrator Metadata Types WHPRCMAP 211 New properties for WHPRCMAN are as follows: OUTPUT TABLES specifies an SCL list of general identifying information about the output tables of this process. All WHPRCMAN processes will have at least one output table that is associated with them (a WHTABLE subtype). SOURCE CODE specifies an SCL list of general identifying information about the source code for this process. This source code is the same as is seen when you select View Code All in the SAS/Warehouse Administrator Process Editor. The source code information that is returned here will be that of a temporary, working location of a copy of the source code and might be different for each request for this information. SOURCE FILE specifies an SCL list of general identifying information about any user-registered code for a process. This list must be of type WHSRCCAT or a subtype of WHSRCCAT. WHJOBCAT or any subtype of WHJOBCAT will be rejected, however. For process steps that consist of user-written code, this property returns the registered source code location. For process steps that consist of code that is generated by SAS/Warehouse Administrator, this property will return an empty list. SUBPROCESSES specifies an SCL list of general identifying information about any subprocesses that might be registered for this process. This list must be of type WHPRCSPR or a subtype of WHPRCSPR. Using WHPRCMAN Add Update Delete No No No WHPRCMAN is a dependent type. WHPRCMAN has the same usage information as “WHPROCES” on page 223. WHPRCMAP Metadata type for data mapping processes Category: Process Types Parent “WHPRCMAN” on page 209 . Process Types Parent “WHPROCES” on page 22 3 21 0 WHPRCMAN Chapter 3 Overview WHPRCMAN is one of the base types for main processes in the SAS/Warehouse Administrator Process Editor. It is the parent. models in “Relationships Among Metadata Types” on page 53. For details about reading process information, see “Reading Process Flow Metadata on page 62. WHPRCMAN Base metadata type for main processes Category:. same usage information as “WHPROCES” on page 22 3. WHPRCMAP Metadata type for data mapping processes Category: Process Types Parent “WHPRCMAN” on page 20 9