Parameter Name

Description

Value

Default

Unique to ArchiveManager

–purge

To purge, enter the –purge switch. When purging, objects are written to an archive file and deleted from the database. The objects to be purged are defined by a purge/archive directives file. This parameter is required for to purge.

Boolean

Yes

–archive

To archive, enter the –archive switch. When archiving, objects are written to an archive file but not deleted from the database. The objects to be archived are defined by a purge/archive directives file. This parameter is required to archive.

Boolean

No

–directive <filename>

Enter the –directive switch, followed by the purge/archive directives file that defines which objects to purge or archive. This parameter is required to purge or archive. See the Purge/Archive Directives File section for more information. A prototype of the purge/archive directives file can be created by using the –generate switch.

String

No

–adp_verbose

Allows verbose/extended information to be placed in the adp_db_comments table.

Boolean

No

Yes

–auto_unique

Outputs a unique key for each object.

Note: The objid field is the unique field if –objid is specified.

Boolean

No

Yes

–checksum <license key>

Generates an updated file checksum - no purge or archive will occur. To use this parameter, you must have write permission to the file. This permission requirement prevents any unauthorized creation of purge/archive directives files. For more information, refer to the Updating the Checksum section.

Hexa-decimal

Yes

–compact

Writes out a smaller output file. This file can be a quarter of the size of a normal output file, but it is not easily readable.

Boolean

No

Yes

–eindex

Generates a DART index file for the archive. Before ArchiveManager version 2.0.1, the DART index file was generated by default.

Boolean

No

Yes

–esplit <split string>

Uses the specified string as the split string in DART index files.

String

!!#*$

Yes

–index_analyze

Analyzes the purge file and reports what indexes should be created. When this parameter is used, the purge will not be performed.

Boolean

No

Yes

–index_no_create

To aid purging, this parameter tells the system to not create indexes in the Clarify database.

Note: We recommend allowing ArchiveManager to create indexes; however, not all ArchiveManager users have permission to create indexes.

Boolean

No

Yes

–index_save

Saves the indexes created during a purge, which are normally deleted by default.

Boolean

No

Yes

–index_threshold <integer>

Creates an index if there are 'n' objects that can be accessed through this relation.

Integer

1

Yes

–expdef

Export fields that have no value in the database.

By default, ArchiveManager will only write data to the export file is the field contains data. Empty strings and NULL values will not be exported. To export all fields, including empty strings and NULLs, use the –expdef parameter.

Boolean

No

Yes

–no_iterative_purge

Objects will be deleted at the end of the purge run only, instead of during the purge as object hierarchies are read and written from the database.

Boolean

No

Yes

–no_stopif

The stop_if statements in the purge/archive directives file will not be processed. This parameter is useful when archiving out items that will be imported into a parallel database.

Boolean

No

Yes

–no_write

No archive file will be generated.

Boolean

No

Yes

–objid

Outputs the object ids into the archive file, and allows the objid to be used as a unique key.

Warning: We do not recommend using this parameter, but Clarify supplied .arc files rely on it.

Boolean

No

Yes

–P_template <filename>

The location of the template file is used as the basis of the DART index file. The default is to use the standard format compiled internally into ArchiveManager.

String

Built in template is used

Yes

–recycle <object type>

In a purge, use the –recycle parameter to return the objids of a specified object type to the unused table. This parameter can be given multiple times to specify different object types, or, to recycle all objids, use 'all'. This parameter is supplied for users whose system is short on objids and for those who need to recover the objids by purging objects. This parameter only works for Clarify versions that support the unused table.

Warning: Recycling objids of existing but purged objects breaks the CLARIFY data model.

Warning: Recycling objids and purging by using objids as unique fields is allowed, but this may cause your database to be corrupted when the archive is reimported to the database.

String

Yes

–report <number>

Reports on the progress every <number> objects purged/archived out. The default is chosen as a number between 1% and 0.5% of the total objects.

Integer

Approx

1% of total

Yes

–thorough

Objects being deleted will be thoroughly purged: OTMs will be reset, OTOFs pointing to the object will be reset, related MTMs will be deleted, and related binary data records will be deleted.

Boolean

No

Yes

–where <SQL expression>

Used for purging, this parameter will overwrite the WHERE condition in the archive file and only select the objects that meet the conditions of the specified SQL expression.

Note: The string in the where clause is an exact SQL search clause, may need to be enclosed in double quotes, see the examples in the next section.

It must match a search clause that would work in SQL. Therefore, all data must be in the format of the SQL search, including dates. The ORACLE date format is: 'MM/DD/YYYY HH24:MI:SS'

When dealing with Unicode string constants, you must precede all Unicode strings with a capital letter N. For example, "WHERE title = N'rιsumι'"

String

Use archive file where clause

Yes

See Also

Purge/Archive Command Syntax

Purge/Archive Command Syntax Examples

Next

Purge/Archive Command Syntax Examples