SAS/Warehouse Administrator Metadata Types

WHDBMS

Metadata type for DBMS connection definitions

Category:

Global Metadata Types

Parent
Overview
Properties
Using WHDBMS

Parent

WHROOT

Overview

WHDBMS models the metadata for a database management system connection definition in SAS/Warehouse Administrator. All warehouses in an environment can share DBMS definitions. In SAS/Warehouse Administrator, to add a DBMS connection definition to the current environment in the Explorer:

Select File Setup from the pull-down menu.
Select DBMS Connections.
Click Add.
Enter the connection information.

Properties

The following table lists all of the properties for WHDBMS and indicates how you can use each property with metadata API methods.

In the table, you can pass properties with a Yes in the Add column to the _ADD_METADATA_ method. Use this method to add a new object.

You can pass properties with a Yes 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 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	Add Method	Update Method	Read Method Expand Parm.
Connection Options	L	Yes	Yes	No
Cvalue	C	Yes	No	No
Desc	C	Yes	Yes	No
Extended Attributes	L	Yes	Yes	Yes
Icon	C	Yes	Yes	No
Id	C	No	* Req	No
Libraries	L	No	Yes	No
Metadata Created	C	No	No	No
Metadata Updated	C	No	No	No
Name	C	* Default	Yes	No
Nickname	C	Yes	No	No
Note	L	Yes	Yes	Yes
NValue	N	Yes	Yes	No
Password	C	No	No	No
Tables	L	No	No	No
Userid	C	No	No	No

New properties for WHDBMS are as follows:

CONNECTION OPTIONS

represents an SCL list of options that are needed to access the DBMS in this connection. The SQL sublist contains the options that are needed to access the DBMS through the SQL Pass-Through facility. These are options normally specified in the CONNECT TO statement. The DBLOAD sublist contains statements that are needed to access the DBMS when you use PROC DBLOAD.

LIBRARIES

specifies an SCL list of general identifying information about the libraries that are associated with this DBMS connection.

NICKNAME

specifies the nickname of the DBMS in this connection. Valid nicknames are limited to DB2/AIX, DB2/MVS, Informix, Oracle, SQL Server, and SYBASE.

If a passed nickname is not a known nickname, it is accepted if it is a valid SAS name.

PASSWORD

represents the maximum 200-character string for a password that is registered for this database connection. This property contains the registered password only if the API application is a secure application. The only secure applications currently supported are those registered as add-in generators. See the SAS/Warehouse Administrator User's Guide for documentation on add-in generators. If the API application is not secure, this property returns a blank value if no password has been registered, and it returns XXXXXXXX if the password has been registered.

TABLES

specifies an SCL list of general identifying information about the tables that are associated with this DBMS connection.

USERID

represents the maximum 200-character string for the user ID that is registered for this database connection. This property contains the registered user ID only if the API application is a secure application. The only secure applications currently supported are those that are registered as add-in generators. See the SAS/Warehouse Administrator User's Guide for documentation on add-in generators. If the API application is not secure, this property returns a blank value if no user ID has been registered, and it returns XXXXXXXX if the user ID has been registered.

Using WHDBMS

Add	Update	Delete
Yes	Yes	Yes

WHDBMS is an independent type. To understand how it relates to other types, see the physical storage models in Relationships Among Metadata Types.

Note: The USERID and PASSWORD attributes are only valid with the _GET_METADATA_ method when the API application is a secure application. Currently, the only secure applications are those that are registered as add-in generators. [cautionend]

Top of Page