si deletearchive
deletes archives from the database repository
Synopsis
si deletearchive [--commit] [--[no]deleteIfInUse] [--[no]links] [--mark] [--removeUnreferencedDirectories] [--rollback] [--status] [--[no]targets] [--hostname=server] [--port=number] [--password=password] [--user=name] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [--[no]confirm] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] [(-g|--gui)] archive1, archive2...
Description
si deletearchive deletes archives from the database.
|
|
The --dump option cannot be used with the si deletearchive command. Using this command deletes archives without creating backups for them. Archive backup (and restore) is not availble for individual achives; only configuration management projects that include archives. If you require archive backups, use the si deleteproject command instead.
|
The command works through a multi-phase process called a delete session. The delete session is as follows:
1. Mark starts the delete session. Prepares to delete the specified archives by marking them as new candidates.
|
|
At any phase before Commit, you can enter the Rollback phase to discard the target information, and end the delete session with the database unchanged.
|
2. Commit deletes all of the delete targets identified in the Mark stage, breaks links to deleted objects, and then ends the delete session.
For more detailed information on performing a delete session, see the Windchill RV&S Help Center.
Options
This command takes the universal options available to all
si commands, as well as some general options. See the
options reference page for descriptions.
• --commit
subcommand: Commits the deletion by permanently deleting the marked objects.
• --[no]deleteIfInUse
used with the --mark subcommand, and specifies if to delete targets that are still in use. One case when a project or archive is still in use is when an out-of-tree item is referring to it. However, it is beyond the scope of this documentation to provide all possible situations when an archive is still in use.
• --[no]links
used with the --status subcommand, and displays a list of all links that are broken upon commit.
• --mark
subcommand: Starts a delete session by marking objects and their dependents as new candidates. The subcommand determines what objects are to be delete targets (archives to be deleted) and what objects are to be kept candidates.
|
|
The Windchill RV&S Server only supports one delete session at a time and additional targets cannot be added with a second invocation of the --mark subcommand.
|
Kept candidates are members that are not deleted for one of the following reasons:
◦ You do not have DeleteArchive permission for the members.
◦ You used the --nodeleteIfInUse option, and the members are referenced by an outside link. The link can be to any revision referenced in another project. The link can also be that there are shared member archives in other projects that are not specified for the purge session.
• --removeUnreferencedDirectories
used with the commit subcommand. Allows the administrator to select or skip the automatic removal of unreferenced directories. If the option is not set, no cleanup step occurs. If the option is set, the cleanup step occurs automatically after running si deletearchive. Depending on the number of unreferenced directories that are found, this cleanup step can take an extended amount of time. By default, --removeUnreferencedDirectories is unset and no cleanup is done for unreferenced directories as part of the si deletearchive command. This option does not apply for other subcommands, such as --dump or --mark.
• --rollback
subcommand: Cancels a delete session, leaving the database unchanged. This subcommand can only be used in phases prior to Commit.
• --status
subcommand: displays the status of the current delete session.
• --[no]targets
used with the --status subcommand, to display all delete targets and kept reasons.
• --[no]confirm
specifies if to confirm the delete operation.
• archive1, archive2...
specifies archives for the current delete session.
Diagnostics
See the
diagnostics reference page for possible exit status values.
Preferences
Using
si setprefs or
si viewprefs, you are able to set or view the preference keys for this command.
See Also
