Microsoft Jet and Replication Objects

CompactDatabase Method

    Example    Applies To

Copies and compacts a closed database, and gives you the option of changing its version, collating order, encryption, and other options.

Syntax

JetEngine.CompactDatabase(SourceConnection, DestConnection)

Parameters

SourceConnection   A String value specifying a connection to the source database to be compacted. An error will occur if the database specified by SourceConnection is already open.

DestConnection   A String value specifying a connection to the destination database to be created by the compaction. An error will occur if the database specified by DestConnection already exists or another file with that name already exists.

Remarks

Connection properties are used to specify information for compacting the database. At a minimum, the Data Source property must be specified for both SourceConnection and DestConnection. The table below lists the connection properties that you can use with this method. All other connection properties will be ignored.

Property	Source	Destination	Description
Provider			Indicates the name of the provider to use to connect to the data source. If this property is not specified, the Microsoft.Jet.OLEDB.4.0 provider is assumed. An error occurs if the name of the provider in the source string is different from the name of the provider in the destination string.
Data Source			Indicates the name of the database. This property is required for both the source and destination connection information.
User Id			Indicates the name of the user if the source database is secured.
Password			Indicates the password for the user if the source database is secured.
Locale Identifier			Indicates the locale id for the new database. If this is omitted, the destination database will have the same locale id as the source database. Locale specifies the collating order for string comparisons in the database. For destination database values, see the Remarks section.
Jet OLEDB:Database Password			Indicates the password if the database is secured by a password.
Jet OLEDB:Engine Type			Indicates the version of the source database to open or the version of the new database to be created. The OLE DB engine types that you can use are: 1 for JET Version 1.0 2 for JET Version 1.1 3 for JET Version 2.x 4 for JET Version 3.x 5 for JET Version 4.x If this is omitted for the destination database, it will default to 5. The value for the destination database cannot be a version prior to that of the source database.
Jet OLEDB:Registry Path			Sets information about the Windows Registry key that contains values for the Microsoft Jet Database Engine.
Jet OLEDB:System Database			Indicates the location of the system database.
Jet OLEDB:Encrypt Database			Indicates whether to encrypt the new database. If this parameter is omitted, the new database will have the same encryption as the source database.
Jet OLEDB:Don't Copy Locale on Compact			Indicates that the database sort order should be used, overriding any per-column locale settings. (Boolean.)
Jet OLEDB:Compact Without Relationships			Indicates whether to copy relationships to the new database. (Boolean.)
Jet OLEDB:Compact Without Replica Repair			Indicates whether to try and find other replicas to repair damaged replicated databases. (Boolean.)

It is not possible to do an "in place" compact, that is, one in which the source database and destination database are the same, using this method. An error will occur if the provider does not support compacting Jet databases.

Remarks

The following table lists the destination database and Locale Identifier (LCID) values:

Note   The General sort order contains the following languages: Africaans, Albanian, Arabic, Basque, Bulgarian, Byelorussian, Catalan, Dutch, English, Faeroese, Farsi, German - Standard, Greek, Hebrew, Hindi, Indonesian, Italian, Malay, Portuguese, Russian, Serbian, Swahili, Urdu.