ALTER SERVER Statement

Enables you to change the server configuration by specifying server options. Here is the syntax:

ALTER SERVER
    [ alter-server-options ]

Here are the options for the ALTER SERVER statement:

alter-server-options

Specifies the list of server options to alter.

alter-server-options ::=
   "{" OPTIONS ["("] alter-server-option
                [{ "," alter-server-option } ... ] [")"]"}"

alter-server-option

Specifies the server option to alter.

alter-server-option ::=
      [alter-operation ]server-option | cache-option

alter-operation

Indicates the required action for the specified options. ADD is the default operation if a value is not set. The possible values are:

ADD

Use ADD to add the specified option.

SET

Use SET to change an option that already exists.

XSET

Use XSET to set the option if it has previously been added. Otherwise, XSET adds the option if it does not exist.

DROP

Use DROP to drop the specified option.

server-option

Specifies the server configuration as one of the following options:

FILEDSNPATH | FILEDSN_ROOT

FILEDSNPATH | FILEDSN_ROOT directory-path

File DSN content location root for FILEDSN and SAVEFILE keywords. This path can be absolute or relative to the server's root content location specified in the server configuration file.

PURGE CACHE

PURGE_CACHE time-out-value

Specifies in minutes, how often old data cache tables are removed from the server. A positive time value indicates the interval at which the cleanup thread will check for items to purge. A negative time-out-value means that cleanup happens only in response to an explicit PURGE CACHE command. A value of 0 indicates that old cache tables are removed after a CREATE CACHE, REFRESH CACHE, or PURGE CACHE command is issued.

TRACEFILEPATH | TRACEFILE_ROOT

TRACEFILEPATH | TRACEFILE_ROOT directory-path

Specifies the trace file content location root for TRACEFILE keywords and the TRACEFILE environment handle attribute. The trace file path is used to store all trace files that are created, either from SAS Federation Server start up or when enabled on a connection. This path can be absolute or relative to the server's ContentRoot that is specified in the server configuration file. The default trace file path is drive:\Program Files\SASHome\FedServer\server instance\var. The DRIVER_TRACEFILE= path that is set in the connection option, DRIVER TRACE, is resolved against the path that is set here.

SHARED LOGIN MANAGER

SHAREDLOGINMANAGER manager

The Authentication Server manager account that will be used to retrieve the shared login map credentials. The shared login manager is paired with a password.

SHARED LOGIN PASSWORD

SHAREDLOGINPASSWORD password

The Authentication Server password for the manager account used to retrieve the shared login map credentials.

Note: Shared login manager and password options are paired.

SHARED LOGIN KEY

SHAREDLOGINKEY key

The Authentication Server grouping key used to search for shared login map credentials.

TRUSTED USER ID

TRUSTED_USER_UID userid

The Authentication Server trusted user account that is used to act on behalf of other users for purposes of retrieving user-owned logins and group memberships (trusting that those users have already been authenticated). The Federation Server makes a trusted user connection to Authentication Server to process queries on definer's rights views since these views retrieve SQL data under the identity of the view's schema owner (the definer) rather than the invoking user.

TRUSTED USER PWD

TRUSTED_USER_PWD password

Specifies the password for the TRUSTED_USER_UID.

Note: The Shared Login and Trusted User passwords are encrypted. SAS Proprietary Encryption is the default and the method of encryption can vary depending on the security platform where SAS Federation Server is installed. If DataFlux Secure for SAS Federation Server has been installed, AES encryption can be used.

CONNECTION POOLING

CONNECTION_POOLING[N[O]|F[ALSE]|OFF|Y[ES]|T[RUE]|O[N]]

This option controls connection pooling for the server. If connection pooling is enabled, database connections are not immediately disconnected upon client request. Instead, the connections are put into a connection pool so that they can be reused by subsequent connection requests for the same database with the same attributes and credentials.

CONNECTION POOLING TIMEOUT

CONNECTION_POOL_TIMEOUT seconds

This option identifies the time in seconds an unused connection stays in the connection pool. The default is 60 seconds. If the option is unset or set to 0, the connection stays in the pool for 60 seconds. If the time is exceeded, the connection is removed from the pool and the connection is closed.

CONNECTION POOLING MAXSIZE

CONNECTION_POOL_MAXSIZE maxsize

This option identifies the maximum number of unused connections in the connection pool. The default is 50. If the option is not set or set to 0, a maximum number of 50 connections are kept in the pool. If the maximum number of connections is reached and a new connection is added to the connection pool, the oldest connection is removed from the pool and the connection is closed.

cache-option : :=

Specifies a list of cache options and can be one of the following:

CACHE ( NAME cache-name, cache-property cache-property value )

The NAME option specifies the name of the cache. Cache properties for that particular cache are altered or created within the sublist. Normal generic SQL options syntax and rules apply to the CACHE option and its suboptions.

cache name: : =

Specifies the name of the Authentication Server (AS) cache.

AS: All AS cached resources.

AS.Name: All AS.Name mappings.

AS.Name.Subjects: User name to AS identifier cache.

AS.Name.Groups: Group name to AS identifier cache.

AS.Subject: All AS.Subject cache resources.

AS.Subject.Groups: User group memberships cache.

AS.Subject.Principals: User principal listings cache.

AS.List: Listings.

AS.List.Subjects: User listings cache.

AS.List.Groups: Group listings cache.

Authorization: Privileges.

ResultSet: Result set caches.

ResultSet.View: Materialized view cache (VDC).

cache-property : : =

Used to specify a property of the cache.

TIMEOUT

TIMEOUT=n

TIMEOUT is the number of seconds before the cache data becomes stale after a refresh. After timing out, the cache is emptied and refreshed on demand or emptied automatically, depending on the cache implementation. TIMEOUT can be set for multiple related caches by specifying a non-terminal cache namespace for the name suboption such as AS.List instead of AS.List.Groups. A value of -1 corresponds to infinite and a value of 0 corresponds to immediate. The default timeout value is 0 for all caches if not set through a parent namespace.

CONOPTS

Use the CONOPTS connection string option to call the FedSQL driver and set SQL statement limits.

FedSQL Driver

CONOPTS(driver FEDSQL)

FedSQL is the required driver for SQL requests on SAS Federation Server.

SQL Statement Limit

DEFAULT_ATTR(SQL_STMT_MEM_LIMIT = n)

Use the SQL_STATEMENT_LIMIT connection string option to control the amount of memory available to answer SQL requests, and enforce this limit for all connections. If the option is specifically set on a particular DSN, then the DSN value should override the system setting. (n)umber is treated as an integer and is specified in bytes.

Examples:

ALTER SERVER {OPTIONS add TRACEFILEPATH "C:\tracefiles"}

ALTER SERVER {OPTIONS add TRACEFILEPATH "logs\tracefiles"}

ALTER SERVER {OPTIONS xset SHAREDLOGINKEY 'DefaultKey'}

ALTER SERVER {OPTIONS( CACHE(NAME AS.Subject, TIMEOUT 300),
 CACHE(NAME AS.List.Subjects, TIMEOUT 60) )}

ALTER SERVER {OPTIONS(xset PURGE_CACHE 30)}

ALTER SERVER {options CONOPTS(driver FEDSQL, 
xset DEFAULT_ATTR(SQL_STMT_MEM_LIMIT 8000000))}