The SAS Federation Server Database

Overview

The SAS Federation Server database is a transactional database, or system catalog (SYSCAT) that contains configuration metadata. Configuration metadata includes the list of created data services, DSNs, privileges, and other information generated as a result of configuring SAS Federation Server. This information is stored in a database because the metadata must be in a consistent state which requires the use of ACID transactions (atomicity, consistency, isolation and durability).

The system catalog contains information about the configuration of SAS Federation Server. This information can be returned to the user through queries against information views.

Working with the SAS Federation Server Database

Creation of the Database

The SAS Federation Server database is created once when SAS Federation Server is initially invoked. At that time, a set of system tables is created to hold various objects that are created as the server is configured. For example, when a data service is created, the system tables are updated to hold the definition of the new data service. Each time a change is made to the server configuration, the system tables in the database are modified. The database can be backed up at any time to capture and preserve a particular server configuration. The default location of the database is <installation root>\SASHome\SASFederationServer\version\var and is called SYSCAT.TDB. The name and location are contained in the dfs_entities.dtd configuration file.

Changing the Database Location

If the location of the SAS Federation Server database changes, the following configurations require updates:

dfs_serv_common.xml/dfs_entities.dtd

Using dfs_entities.dtd, change the value of the TranPath option to point to the new location of the SYSCAT transactional database. This configuration change effects the dfs_serv_common.xml configuration file.

dfs_log_SQL_Logging.xml/dfs_entities.dtd

Using dfs_entities.dtd, change the value for the FIREBIRD_LOCK environment variable to point to the new location of the SYSCAT transactional database. This configuration change updates the location of the database lock files for both the SQL_LOG and SYSCAT transactional databases. When updating the FIREBIRD_LOCK environment variable, use an absolute path only.

dfs_log.xml

Change the value of the DFS_DBAPPENDER_DB entity to point to the new location. This changes the location of the SQL_LOG transactional database.

Backing Up SAS Federation Server Database

It is a best practice to periodically back up the SAS Federation Server database, including the system catalog, SYSCAT.TDB. As mentioned previously, you can backup the database at any time to capture and preserve a particular server configuration. SAS Federation Server can remain active during backup. There is no need to shut the server down. For additional information, refer to Database Backup and Restore in Utilities for SAS Federation Server .