Switches to use with the Compact server task

Technote (FAQ)


Question

What switches are available when running the Compact server task in Lotus Notes/Lotus Domino?

Answer

The default compaction style is "in-place compaction".
NOTE: When the Compact task runs, it opens the database to find out the amount of "% used" (as opposed to looking in log.nsf).

When running Compact from the server console, the syntax is as follows:
load compact databasename -switch

The switches in the following table are new and apply to the Notes/Domino V8.5 and future releases:

Command line equivalent
Description
-daos on Enables the "Use Domino Attachment and Object Service" (DAOS) database property. (Use with -C to move current objects into DAOS.
-daos off Disables the "Use Domino Attachment and Object Service" database property. (Use with -C to move current objects out of DAOS.
-S nnnK Compact database if unused space estimate >= nnn KB.
-S nnnM Compact database if unused space estimate >= nnn MB.
-S nn Compact database if unused space estimate >= nn percent.
-Y Recurse through subdirectories (default).
-0 Process NSFDB2 databases only. This will ignore NSF databases and is to be used with other switches.
-* Include *.ntf and *.box when processing a directory


Compact - Style
Option
Command-line equivalent
Description
Changes DBIID
Notes/Domino release
Compaction style: In-place (recommended) -b Uses in-place compaction and recovers unused space without reducing the file size unless there's a pending structural change to a database. In this case, copy-style compaction occurs. Recommended method of compacting.

-b is the only switch that will not change the DBIID of a database if transactional logging is enabled.
n
8, 7, 6, 5 releases
Compaction style: In-place with file size reduction -B Uses in-place compaction, recovers unused space, reduces file size unless there's a pending structural change in which case copy-style compacting occurs. If you use transaction logging, do full database backups after compacting completes.
n
8, 7, 6, 5 releases
* Compaction style: Copy-style -c or -C Uses copy-style compaction.
Use this option to solve database corruption problems.
Changes DBIID.
Reduces file-size.
NOTE: Unused (white) space is not copied over, only data and view indexes

** If the parameters, Create_R8_Databases=1 or Create_R85_Databases=1 are appearing for the first time in the notes.ini file when the .nsf is being compressed, a database design compression occurs and will reduce the file size significantly. Refer to the information in "Using database design compression."
y
8, 7, 6, 5 releases
* Compaction style: Copy-style: Allow access while compacting -L
Upper or lower case 'L' will work.
Enables users to continue to access databases during compacting. If a user edits a database during compacting, compacting is cancelled. Useful only when copy-style compacting is done.
--
8, 7, 6, 5 releases
* Compaction style: Copy-style: Ignore errors and proceed -i
Upper and lower case 'I' will work in R4 but only lower case 'i' will work in R5 and later releases.

NOTE: The -i option must be used together with -c or -L. Otherwise, you get the error, "Ignore errors is only allowed with copy-style compaction."
Enables compacting to continue even if it encounters errors such as document corruption. Only used for copy-style compaction.
--
8, 7, 6, 5 releases
Check for overlapping obects -o or -O If using in-place compaction, checks for overlapping objects and switches to copy style if any are found.
n
8, 7, 6, 5 releases
* Most of the time after a copy-style compact, an Updall is required. For more information, refer to Document #1085954, " Updall switches Update and NIF - Notes indexing basics."

Compact - Options
Option
Command-line equivalent
Description
Changes DBIID
Compact database only if unused space is greater than x percent -S percent Compacts all databases with a specified percent of unused space. Example: if you specify 10, databases with 10% or more recorded unused space are compacted. Unused space calculation is not always a reliable measure of unused space.
n
Discard any built view indexes -D Discards built view indexes.
Use to compact databases just before you store them on tape.
(Does -C copy-style compacting)
Changes DBIID.
Reduces file-size.
y
Keep or revert database to previous format -R Compacts databases without converting to the current release file format of the server that stores the databases, or reverts databases in the current release file format to the previous release file format. For example, on Domino 6 servers, this option compacts Domino 5 databases without converting them to Domino 6 file format, and converts Domino 6 databases to Domino 5 file format. Uses copy-style compacting.
y


Compact - Advanced
Option
Command-line equivalent
Description
Notes/Domino release
No-Execute -e
Upper or lower case 'E' will work.
Show effective arguments without execution since some arguments affect others. For example, -i only works with -c, so executing the compact command first with -e on the end is a good way to check syntax without actually compacting a database. 8, 7, 6, 5 releases
Document table bitmap optimization: Off -f Disables the "Document table bitmap optimization" database property. Does copy-style compaction. 8, 7, 6, 5 releases
Document table bitmap optimization: On -F Enables the "Document table bitmap optimization" database property. Does copy-style compaction. 8, 7, 6, 5 releases
Don't support specialized response hierarchy: Off -h Disables the "Don't support specialized response hierarchy" database property. Does copy-style compaction. 8, 7, 6, 5 releases
Don't support specialized response hierarchy: On -H Enables the "Don't support specialized response hierarchy" database property. Does copy-style compaction. 8, 7, 6, 5 releases
Enable transaction logging: On -T Enables transaction logging. 8, 7, 6, 5 releases
Enable transaction logging: Off -t Disables transaction logging. 8, 7, 6, 5 releases
Maintain unread marks: On -u Disables the "Don't maintain unread marks" database property. 8, 7, 6, 5 releases
Maintain unread marks: Off -U Enables the "Don't maintain unread marks" database property. 8, 7, 6, 5 releases
Allow for a larger UNK table -K Allows for a larger UNK table in a database past 64K.
NOTE: Not available through the Compact tool on the Files tab in Domino Administrator.
8, 7, 6, 5 releases
Disable large (>64 KB) UNK table -k Removes large UNK table in database.
NOTE: Not available through the Compact tool on the Files tab in Domino Administrator.
8, 7, 6, 5 releases
No equivalent option. -ZU
Converts document attachments using compression type Huffman to LZ1.
NOTE: The database property, "Use LZ1 compression for attachments", must be enabled for this switch to be effective.

In 6.5.6, the following notes.ini parameter must also be set: DEBUG_ENABLE_LZ1_REPAIR=1
Domino 6.5.6, 7.0.1 and later
No equivalent option. -ZD Converts document attachments using compression type LZ1 to Huffman.

In 6.5.6, the following notes.ini parameter must also be set: DEBUG_ENABLE_LZ1_REPAIR=1
Domino 6.5.6, 7.0.1 and later
Make views small -V Disables the "Compress document data" database property such as non-summary (body) item data.
NOTE: Use "-c" with both "-V" and "-v" to enable or disable compression of current document data.
Domino 8 and later
Make views big -v Enables the "Compress document data" database property.
NOTE: Use "-c" with both "-V" and "-v" to enable or disable compression of current document data.
Domino 8 and later
Make Notes small -n Compresses data Domino 8 and later
Make Notes big -N Uncompresses data Domino 8 and later


Compact - Archive
If you want to use the document archiving tool to archive and delete documents in a database, you can use the following Compact
options to archive documents if the database is located on a server and you've chosen the advanced archiving option, "Automatically on server."
Option
Command-line equivalent
Description
Notes/Domino release
Archive only -A Archives and deletes documents from a database without compacting the database. 8, 7, 6, 5 releases
Archive and then compact -a Archives and deletes documents from a database and then compacts the database. 8, 7, 6, 5 releases
Delete and then archive -j Deletes documents from a database and then compacts the database.
NOTE: Not available through the Compact tool on the Files tab in Domino Administrator.
Domino 6 and later

Related information

A simplified Chinese translation is available


    Cross reference information
    Segment Product Component Platform Version Edition
    Messaging Applications IBM Notes Lotus Notes Linux, Windows 8.5, 8.0, 7.0, 6.5, 6.0, 5.0

    Historical Number

    172454

Rate this page:

(0 users)Average rating

Document information


More support for:

IBM Domino
Server Tasks

Software version:

6.5, 7.0, 8.0, 8.5

Operating system(s):

AIX, Linux, Solaris, Windows

Reference #:

1084388

Modified date:

2010-07-19

Translate my page

Machine Translation

Content navigation