purge

Build 1501 on 14/Nov/2017  This topic last edited on: 22/Mar/2016, at 16:27

purge [-<option> . . .]

Removes from the database deleted objects.

Options

[-ids] <comma-separated database ids>

   List of object id(s) to purge. Optional, if specified it overrides all other parameters used to specify which objects to purge.

-codes <comma-separated list of spike codes>

   List of spike codes of the objects to purge. Optional, if not specified objects deleted with any spike code will be purged.

-types <comma-separated list of object type names>

   List of the types of the objects to purge. Optional, if not specified objects of any type will be purged.

-since <time-span; e.g. 4:30 for 4 hours and 30 minutes, 2.06:00 for 2 days and 6 hours>

Purge only the objects that have been deleted since the specified number of days / hours / minutes. Optional, if not specified only objects deleted more than 365 days ago will be purged.

-list

If specified the command will just list the objects that will be purged, instead than actually purging them.

-by <integer>

Number of objects to purge together in a single operation. Greater the number quicker the operation is, and longer locks are put on the database. Optional, default value 50.

-auto

If present, match the objects with a specified purge-time (see Spike command) and this is a past time-value; if the purge-time isn't specified, are used the "since" option rules

-username <string>

The optional user name to use to login into the system. If not specified the Web service login is used. Ignored in interactive mode.

-password <string>

The user password to use to login into the system. Ignored if no system user name is specified. Ignored in interactive mode.

-lang <string>

User-interface language, e.g. 'en-US' for English, US version. Ignored in interactive mode.

-srvname <string>

The name of the Web service connection parameters to use, as defined in the user configuration file (USERCONFIG.XML file, typically stored in C:\Users\<yourWindowsname>\AppData\Roaming\TeraDP\GN4\ on Windows 10 / 8 / 7 / Vista and in c:\Documents and Settings\<user name>\Application Data on Windows XP / Server 2003). If not specified the first connection in the configuration file is used. Ignored in interactive mode.

Notes:

When using this parameter, have in mind that there is no way to ensure that the same name in the USERCONFIG.XML file gets used coherently on all network computers. Therefore, this is not a safe method unless you are using it only on well known computers.

Use either -srvname or -srvurl, but not both.

-srvurl <string>

The URL of Web service to connect to, e.g. http://myhost.com/GN4/Adminsrv.asmx. Ignored in interactive mode.

Notes:

When using this parameter, have in mind that it is independent of the USERCONFIG.XML settings, therefore, much safer.

Use either -srvname or -srvurl, but not both.

-srvusername <string>

The Windows user name to use to login to the Web service. If not specified the current Windows login is used, and the password and domain options are ignored. Ignored in interactive mode.

-srvpassword <string>

The Windows user password to use to login to the Web service. Ignored ininteractive mode.

-srvdomain <string>

The domain of the user to use to login to the Web service. Ignored in interactive mode.

-srvpassphrase <string>

Pass-phrase used to encrypt/decrypt data transferred to and from the server. Ignored in interactive mode.