Skip to main content
Version: 3.4.0 (Latest Stable)

uspArchivingExecute

Overview​

The uspArchivingExecute stored procedure is responsible for executing the archiving process for defined data objects within the ExMeX Archive Framework.

Motivation​

Data archiving is essential for optimizing storage management by moving obsolete or inactive data into an archive. This ensures that historical data is preserved securely and remains accessible when needed. Additionally, purging archived data over time helps reduce storage costs and enhances system performance.

Applicability​

This stored procedure is part of the ExMeX Archiving Framework and is used to automate the archiving process.

Syntax​

The structure for invoking the uspArchivingExecute stored procedure is shown below:

MetadataZoneCore.uspArchivingExecute
    @Debug      = <optional>

Input Parameters​

  • @Debug: (Optional) Indicates whether debugging is enabled. Accepts a value of 0 (disabled) or 1 (enabled).

Return Type​

  • Integer: The procedure returns an integer value indicating the execution result.

Return Values​

Return ValueDescription
0Successful execution

Usage Considerations​

When using uspArchivingExecute, the considerations and potential impacts described in the ExMeX Archiving Framework documentation are applicable. These considerations include the timing of archiving operations, performance implications, and how ordering and purging is managed.

Example​

The following example demonstrates how to execute the uspArchivingExecute procedure and retrieve log messages from the archive log:

EXEC MetadataZoneCore.uspArchivingExecute;

SELECT *
FROM MetadataZoneCore.ArchivingLogMessage;