Previous Page | Next Page

Reference to Metadata Objects for the Metadata Engine

Metadata Objects, Listed by Language Element


The Constructed LIBNAME Statement for a Base SAS Engine

The metadata engine constructs a LIBNAME statement based on the stored metadata and uses this LIBNAME statement to access your data. The construction is transparent; however, it is important to understand the components of the LIBNAME statement so that you can configure the metadata appropriately with a product like SAS Management Console. For more information about LIBNAME syntax, see SAS Language Reference: Dictionary for LIBNAME syntax.

Note:   The metadata must already be registered. If you specify METAOUT=DATA, table metadata is not required.  [cautionend]

LIBNAME libref <engine> 'SAS-data-library' <options>;
libref

references the SAS library that the Base SAS engine will process. This value is obtained from the Libref attribute in the SASLibrary object.

engine

is the name of the Base SAS engine that will process the SAS library. This value is obtained from the Engine attribute in the SASLibrary object.

'SAS-data-library'

is the physical name of the SAS library. This value is obtained from the DirectoryName attribute in the Directory object that is associated with the SASLibrary object. The DirectoryName attribute must include any delimiters that are specific to the operating environment.

The Directory object also contains the IsRelative attribute, which indicates whether the value in the DirectoryName attribute is the complete physical name or is relative to a parent directory. If the IsRelative attribute is set to true (1), the metadata engine retrieves the parent directory and obtains the value from its DirectoryName attribute. The metadata engine appends the parent directory's physical name to the beginning of the subdirectory's physical name.

A parent directory can have an IsRelative attribute set to true (1). Several parent directories can be appended to the beginning of the physical name before it is complete.

options

are the LIBNAME statement options for the Base SAS engine. Each option is constructed from the PropertyName, Delimiter, DefaultValue, and UseValueOnly attributes in a Property object.

Property objects can be associated directly with the SASLibrary object. PropertySet objects can associate different groups of Property objects with the SASLibrary object. For more information, see How the Metadata Engine Constructs Options.


The Constructed LIBNAME Statement for a DBMS SAS/ACCESS Engine

The metadata engine constructs a LIBNAME statement for a DBMS SAS/ACCESS engine based on the stored metadata and uses this LIBNAME statement to access your data. The construction is transparent; however, it is important to understand the components of the LIBNAME statement so that you can configure the metadata appropriately with a product like SAS Management Console. For more information about LIBNAME syntax, see the documentation for the specific SAS/ACCESS product.

Note:   The metadata must already be registered. If you specify METAOUT=DATA, table metadata is not required.  [cautionend]

LIBNAME libref SAS/ACCESS-engine-name<SAS/ACCESS-engine-connection-options> <SAS/ACCESS-LIBNAME-options>;
libref

references the data that the SAS/ACCESS engine will process. This value is obtained from the Libref attribute in the SASLibrary object.

SAS/ACCESS-engine-name

is the name of the underlying engine that will process the data. This value is obtained from the Engine attribute in the SASLibrary object.

SAS/ACCESS-engine-connection-options

are the engine-specific connection options for the LIBNAME statement for the SAS/ACCESS engine. Each option is constructed from the PropertyName, Delimiter, DefaultValue, and UseValueOnly attributes in a Property object.

Property objects can be associated directly with the SASClientConnection object that is associated with the SASLibrary object. PropertySet objects can associate different groups of Property objects with the SASClientConnection object. For more information, see How the Metadata Engine Constructs Options.

Exception: The values for the USERID= and PASSWORD= connection options are obtained from a Login object. The Login object can be associated with the SASLibrary object. If no Login object is associated with the SASLibrary object, a Login object is obtained from the AuthenticationDomain object that is associated with the SASClientConnection object.
SAS/ACCESS-LIBNAME-options

are the LIBNAME statement options for the SAS/ACCESS engine. Each option is constructed from the PropertyName, Delimiter, DefaultValue, and UseValueOnly attributes in a Property object.

Property objects can be associated directly with the SASLibrary object. PropertySet objects can associate different groups of Property objects with the SASLibrary object. For more information, see How the Metadata Engine Constructs Options.

Exception: The value for the SCHEMA= option is obtained from a DatabaseSchema object. The DatabaseSchema object must be associated with the SASLibrary object if the SAS library is processed by a SAS/ACCESS engine.

The Constructed LIBNAME Statement for the REMOTE Engine

The metadata engine constructs a LIBNAME statement for the REMOTE engine based on the stored metadata and uses this LIBNAME statement to access your data. The construction is transparent; however, it is important to understand the components of the LIBNAME statement so that you can configure the metadata appropriately with a product like SAS Management Console. For more information about LIBNAME syntax, see the SAS/SHARE User's Guide.

Note:   The metadata must already be registered. If you specify METAOUT=DATA, table metadata is not required.  [cautionend]

LIBNAME libref SERVER=serverid <ACCESS=READONLY> <OUTREP=format> <USER=userid> <PASSWORD=password> <SAPW=server-access-password> <SLIBREF=server-libref> ;
libref

references the local SAS library. This value is obtained from the Libref attribute in the SASLibrary object for the local SAS library. This value can be the same as the value for the Libref attribute in the SASLibrary object for the remote SAS library.

SERVER=serverid

specifies a name for the SAS server. This value is constructed from the PropertyName, Delimiter, DefaultValue, and UseValueOnly attributes in a Property object that is associated with the SASClientConnection object for the SAS server.

ACCESS=READONLY

controls read access to a data library (in this case, through the SAS server). This value is obtained from the PropertyName, Delimiter, DefaultValue, and UseValueOnly attributes in a Property object that is associated with the local library's SASLibrary object.

OUTREP=format

creates new files in a foreign host format. This value is obtained from the PropertyName, Delimiter, DefaultValue, and UseValueOnly attributes in a Property object that is associated with the local library's SASLibrary object.

USER=user-name

specifies the user ID of the accessing client on the server. This value is obtained from the Userid attribute in a Login object that is associated with the SASLibrary object.

PASSWORD=password

specifies the password for the accessing client on the server. This value is obtained from the Password attribute in a Login object that is associated with the SASLibrary object.

SAPW=server-access-password

specifies a server access password, which is used to gain access to the SAS server. This value is obtained from the Password attribute in a SASPassword object that is associated with the SASClientConnection object for the SAS server.

SLIBREF=server-libref

specifies the libref that is used by the server to identify a SAS library. This value is obtained from the Libref attribute in the remote library's SASLibrary object.

Previous Page | Next Page | Top of Page