Server Control (IServer Interface)

Refresh

Changes certain SAS Metadata Server invocation and configuration options on a running server. This method can also be used to quickly recover memory on the server.

Category: Server control methods

Syntax

rc=Refresh(options);

Parameter	Type	Direction	Description
rc	N	out	Return code for the method. Indicates whether the SAS Metadata Server ran the method call. RC=0 means it did, RC=1 means it did or not.
options	C	in	<ARM system-option(s)/> Invokes specified ARM logging system options. <OMA JOURNALPATH="filename"/> Specifies to stop writing journal entries to the journal file in the current location and resume writing journal entries in a new file in the specified location. This option is ignored if journaling is not enabled on the SAS Metadata Server. <REPOSITORY Id="repository-identifier"/> Specifies to close and reopen the specified metadata repository to recover memory. <RPOSMGR Access="ONLINE"/> Specifies to resume the SAS Repository Manager to an ONLINE state. When the SAS Repository Manager is resumed, metadata repositories are returned to their registered Access value. <SERVER/> Specifies to close and reopen all of the metadata repositories that are managed by the SAS Metadata Server to recover memory.

Parameter

Type

Direction

Description

out

Return code for the method. Indicates whether the SAS Metadata Server ran the method call. RC=0 means it did, RC=1 means it did or not.

options

<ARM system-option(s)/>: Invokes specified ARM logging system options.

<OMA JOURNALPATH="filename"/>: Specifies to stop writing journal entries to the journal file in the current location and resume writing journal entries in a new file in the specified location. This option is ignored if journaling is not enabled on the SAS Metadata Server.

<REPOSITORY Id="repository-identifier"/>: Specifies to close and reopen the specified metadata repository to recover memory.

<RPOSMGR Access="ONLINE"/>: Specifies to resume the SAS Repository Manager to an ONLINE state. When the SAS Repository Manager is resumed, metadata repositories are returned to their registered Access value.

<SERVER/>: Specifies to close and reopen all of the metadata repositories that are managed by the SAS Metadata Server to recover memory.

Details

A user must have administrative user status on the SAS Metadata Server to issue the Refresh method.

Issuing the Refresh method without options has no effect.

When executed with the <SERVER/> element, the Refresh method pauses the SAS Metadata Server to an OFFLINE state, and then resumes it to an ONLINE state, in one step. This process unloads all metadata repositories that are managed by the SAS Metadata Server and the SAS Repository Manager from memory, and closes all repository containers on disk. Memory on the SAS Metadata Server host is quickly recovered.

The <SERVER/> element does not have any attributes. It is specified in the OPTIONS parameter as follows:

<SERVER/>

Issuing the Refresh method with the <ARM system-option/> or <OMA JOURNALPATH="filename"/> element reconfigures a feature on the running SAS Metadata Server.

When issued with the <ARM system-option/> element, Refresh enables or disables ARM logging for all repositories on the metadata server. The option specifies ARM logging system options as follows:
```
<ARM ARMSUBSYS="(ARM_NONE|ARM_OMA)" ARMLOC="fileref|filename"/>
```
"(ARM_NONE)" disables ARM logging on the server. When specified together, "(ARM_OMA)" and ARMLOC="filename" start ARM logging in the specified location. If ARM logging is already enabled, specifying just ARMLOC="filename" writes the ARM log to the specified location. Absolute and relative pathnames are read as different locations. For more information about ARM logging, see "Using the ARM_OMA Subsystem" in the SAS Intelligence Platform: System Administration Guide.
The <OMA JOURNALPATH= "filename"/> element redirects journaling entries to a new journal file in the specified location. The option cannot turn journaling on and off.

The <ARM system-option/> and <OMA JOURNALPATH=" filename"/> elements do not close and reopen repositories. They do not affect memory usage.

The <REPOSITORY/> element unloads the specified metadata repository (or metadata repositories) from memory, closes their containers on disk, and then reopens them. The <REPOSITORY/> element is specified as follows:

<REPOSITORY Id="Reposid|REPOSMGR|ALL"/>

REPOSID

Specifies the unique 8-character or two-part 17-character metadata identifier of a metadata repository. Multiple repositories can be refreshed at once by stacking <REPOSITORY/> elements in the OPTIONS parameter.

Note: The foundation repository should not be refreshed without also refreshing all metadata repositories that depend on it. [cautionend]

REPOSMGR

specifies the SAS Repository Manager.

ALL

Includes all metadata repositories, including the SAS Repository Manager. In SAS releases before 9.2, ALL excluded the SAS Repository Manager. ALL is the default value if <REPOSITORY/> is specified without an Id= value and has the same effect as specifying the <SERVER/> element.

In previous SAS releases, the Refresh method supported a State= attribute in the <REPOSITORY/> element. The State= attribute is deprecated in SAS 9.2. Repositories are always paused to an OFFLINE state and resumed to their current Access= value.

The SAS Metadata Server must refresh repositories when there is no other activity on the server, so it automatically delays other client requests until the Refresh method completes. This might have a small effect on server performance.

Examples

The following example shows how ARM_OMA logging is enabled:

options='<ARM armbsubsys="(ARM_OMA)" armloc="myARM.log"/>';
rc=serverObject.Refresh(options);

The following example shows how ARM_OMA logging is disabled:

options='<ARM armbsubsys="(ARM_NONE)")/>';
rc=serverObject.Refresh(options);

The following example shows how to pause and resume a metadata repository to recover memory:

options='<Repository Id="A5H9YT45"/> ';
rc=serverObject.Refresh(options);

Top of Page