SAS/Warehouse Administrator 2.3 Metadata API- P32 pps

152 WHLDOTBL Chapter 3 Name C * Auto supplied No No Note L Yes Yes Yes NValue N Yes Yes No Output Tables L * Auto supplied No No Owner L No No No Responsibility C * Default Yes No Source Code L No No Yes Source File L Yes Yes Yes Step Source Code L * Auto supplied No Yes Subprocesses L Yes Yes Yes Property Dependencies 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 WHLDOPRX WHLDOPRX is valid for the following metadata API write methods: Add Update Delete No Yes No WHLDOPRX 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. WHLDOTBL Metadata type for OLAP table load processes Category: Process Types—Load Parent “WHPRCLDR” on page 207 SAS/Warehouse Administrator Metadata Types WHLDOTBL 153 Overview WHLDOTBL models the metadata for OLAP table load processes in the SAS/Warehouse Administrator Process Editor. Properties The following table lists all of the properties for WHLDOTBL 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. Administrator L No No No Cvalue C Yes Yes No Desc C * Auto supplied No No Extended Attributes L Yes Yes Yes Host L Yes Yes No Id C * Req * Req No Load Options L Yes (See Property Dependencies) Yes (See Property Dependencies) No Metadata Created C * Auto supplied No No Metadata Updated C * Auto supplied No No Name C * Auto supplied No No Note L Yes Yes Yes NValue N Yes Yes No 154 WHLDOTBL Chapter 3 Output Tables L * Auto supplied No No Owner L No No No Responsibility C * Default Yes No Source Code L No No Yes Source File L Yes Yes Yes Step Source Code L * Auto supplied No Yes Subprocesses L Yes Yes Yes The properties for WHLDOTBL are the same as for WHPRCLDR, with one exception—WHLDOTBL overrides the LOAD OPTIONS property. LOAD OPTIONS indicates an SCL list of options for the specified Load process. For WHLDOTBL, the LOAD OPTIONS property includes the SINGLE PASS item. 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 loading 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. SINGLE PASS ( YES or NO) specifies that when this item is set to YES, data for all crossings will be produced by a single PROC SUMMARY step for maximum performance when you use code that is generated by SAS/ Warehouse Administrator. When this item is set to NO, data for each crossing will be produced by a separate PROC SUMMARY step in order to minimize memory utilization, which can be important in systems with memory size restrictions. TRUNCATE TABLE ( YES or NO) specifies that when refreshing 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 defined in the database. UNION MULTIPLE INPUTS ( YES or NO) specifies that any multiple inputs to the current Load process will be unioned together before loading 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 an OLAP table: SAS/Warehouse Administrator Metadata Types WHLDRDAT 155 LOAD OPTIONS=( GENERATION LEVEL=’2.0’ LOAD TIME COLUMN=’NO’ UNION MULTIPLE INPUTS=’YES’ DROP INDEXES=’NO’ TRUNCATE TABLE=’NO’ SINGLE PASS=’YES’ ) Property Dependencies 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/or STEP SOURCE CODE properties. You can add a load time column to a table as described in the documentation for the WHCOLTIM type. Using WHLDOTBL Add Update Delete No Yes No WHLDOTBL 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. WHLDRDAT Metadata type for data table load processes Category: Process Types—Load Parent “WHPRCLDR” on page 207 Overview WHLDRDAT models the metadata for data table load processes in the SAS/Warehouse Administrator Process Editor. Here is one way to add a data table load process in SAS/Warehouse Administrator: 1 In the Explorer, select a data table with the right mouse button. 2 Select Process from the pop-up menu. 3 In the Process Editor, select the table with the right mouse button. 4 Select Edit Load Step. 5 Enter the process information. 156 WHLDRDAT Chapter 3 Properties The following table lists all of the properties for WHLDRDAT 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. Administrator L No No No Cvalue C Yes Yes No Desc C * Auto suppplied No No Extended Attributes L Yes Yes Yes Host L Yes Yes No Id C * Req * Req No Load Options L Yes (See Property Dependencies) Yes (See Property Dependencies) No Metadata Created C * Auto supplied No No Metadata Updated C * Auto supplied No No Name C * Auto supplied No No Note L Yes Yes Yes NValue N Yes Yes No Output Tables L * Auto supplied No No Owner L No No No Responsibility C * Default Yes No Source Code L No No Yes . Types—Load Parent “WHPRCLDR” on page 20 7 SAS/Warehouse Administrator Metadata Types WHLDOTBL 1 53 Overview WHLDOTBL models the metadata for OLAP table load processes in the SAS/Warehouse Administrator Process. page 20 7 Overview WHLDRDAT models the metadata for data table load processes in the SAS/Warehouse Administrator Process Editor. Here is one way to add a data table load process in SAS/Warehouse Administrator: 1. models in “Relationships Among Metadata Types” on page 53. For details about reading process information, see “Reading Process Flow Metadata on page 62. WHLDRDAT Metadata type for data table load