Table of Contents

Search

  1. About the Data Vault Administrator Guide
  2. Introduction to the Data Vault
  3. Data Vault Service Startup and Shutdown
  4. Data Vault Configuration
  5. Data Vault SSL Setup
  6. Data Vault ODBC Setup
  7. Data Vault Administration
  8. Data Repartitioning
  9. Partial Data Vault Copy
  10. Archived Data Migration
  11. Bulk File Uploader
  12. Data Vault Administration Tool
  13. Data Vault Logs
  14. User Account Privileges
  15. ssasql Command Line Program
  16. Data Vault Audit Log
  17. Sample Configuration Files

Data Vault Administrator Guide

Data Vault Administrator Guide

Data Vault Cleanup

Data Vault Cleanup

Use the ssacleanup utility to remove specified objects from the Data Vault, for example a database, schema, or table. You can also use ssacleanup to remove orphaned SCT files and SCT files assigned to a database that you also remove.
The ssacleanup utility uses the following syntax:
ssacleanup [ <flags> ] -h (displays the help screen) -a (removes orphan SCT files from disk only) -e (reports orphan SCT files from disk only) -b <n> (time in hours to remove orphan files older than <n> hour. Default is 0.5) -c (removes SCT files assigned for database for -d flag) -d <name> (removes database) -l<dir>[,<dir>] (SCT files path(s) for -a mode or -e mode only. Multiple paths are separated by commas) -o (deletes offline SCT files for a database, schema, or table from disk and metadata) -o -e (reports offline SCT files for database/schema/table) -r <dir> (temporary directory for log, report, and runtime files -s <name> (removes schema) -t <name> (removes table) -u UID[/PWD] (Data Vault user name and password)
You can specify the flags in any order. The following table describes the flags:
Option
Description
-h
Displays the help screen.
-e
Generates a report of the orphan SCT files. The report is generated in the current working directory from where ssacleanup is called. If you want to generate and review a report of orphaned SCT files before you remove them, use the
-e
flag.
-a
Removes orphaned files from disk only. You must specify the location of the files with the
-l
flag.
-b
Specifies the time in hours for which the command removes orphaned files older than the number of hours (
<n>
). By default, this value is .5 hours and all orphaned files created more than 30 minutes after running the utility will be deleted. Files that have been created within 30 minutes of running the utility are not deleted by default. This protects SCT files that were recently-created by a running archive loader job, but are not yet registered in the metadata catalog. You can change the default value to retain SCT files that were created within a certain time period.
-c
Removes SCT files assigned to a database object that you will remove by specifying a value for the
-d
flag. By default, all SCT files registered for removed database objects remain on disk. Once cleanup is finished, the files become orphan. Use the
-c
flag to remove the SCT files when you remove the object. Or, you can use the
-a
flag to remove orphaned files at a later time.
-d
Removes the specified database object. This parameter is mandatory for cleaning up Data Vault objects.
-l
Specifies the location of orphaned SCT files that you want to remove. Files that are present in this location but not referenced in the metadata catalog are deleted when you specify the
-a
flag. Both the
-a
flag and
-l
flag are mandatory to remove orphaned files.
You can specify multiple locations. Separate the file paths with a comma.
-o
Unregisters and deletes the offline SCT files that belong to the particular database, schema, or table.
-o deletes only the SCT files from the local disk and does not delete SCT files from any external storage. It unregisters the SCT files regardless of the file location.
For example:
ssacleanup -o -d <DBNAME> -u dba/
will unregister and delete all of the offline SCT files stored on the local disk for the specified database.
-o -e
Generates a report with a list of the offline SCT files that belong to the particular database, schema, or table.
For example:
ssacleanup -o -e -d <DBNAME> -u dba/
will report all of the offline SCT files for the specified database.
-r
Location of the temporary directory for log, report, and run-time files. When you run the utility, it generates a log and a report in the temporary directory. The log file contains information about the functions that were successfully called and exited. Create this directory before you run the command. If you encounter an error, check the log files.
-s
Removes the specified schema.
-t
Removes the specified table.
When you specify a value for
-t<name>
, you must also specify a value for the flags
-d<name>
and
-s<name>
.
-u
Required. Data Vault user name and password.
The Data Vault DBA user or owner of the database with granted privileges must run the ssacleanup utility. If a non-DBA user calls ssacleanup to remove objects that they do not own, the process fails with an authorization error.

0 COMMENTS

We’d like to hear from you!