SqlCeEngine.Compact Method (System.Data.SqlServerCe)

Compact Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

SqlCeEngine..::.Compact Method

Reclaims wasted space in the SQL Server Compact database by creating a new database file from the existing file. This method is also used to change the collating order, encryption, or password settings of the database.

Namespace: System.Data.SqlServerCe
Assembly: System.Data.SqlServerCe (in System.Data.SqlServerCe.dll)

Syntax

Visual Basic (Declaration)

Public Sub Compact ( _
    connectionString As String _
)

Visual Basic (Usage)

Dim instance As SqlCeEngine
Dim connectionString As String

instance.Compact(connectionString)

public void Compact(
    string connectionString
)

Visual C++

public:
void Compact(
    String^ connectionString
)

member Compact : 
        connectionString:string -> unit

JScript

public function Compact(
    connectionString : String
)

Parameters

connectionString: Type: System..::.String
The connection string to the destination database.

Remarks

The connection string specifies a connection to the destination database that will be created by this method.

An exception is thrown if the specified database already exists or if another file with the same name already exists. .

If you pass an empty string for the connection string, the new database file overwrites the old database file and maintains the same name.

Important
Abnormal termination of an application before the Compact operation is completed leaves a temporary database file in the system. This file is named <filename>pack.sdf and must be manually removed.

Examples

The following example demonstrates how to compact a SQL Server Compact database.

Visual Basic

Dim engine As New SqlCeEngine("Data Source = AdventureWorks.sdf")

' Specify null destination connection string for in-place compaction
'
engine.Compact(Nothing)

' Specify connection string for new database options; The following 
' tokens are valid:
'      - Password
'      - LCID
'      - Encrypt
' 
' All other SqlCeConnection.ConnectionString tokens are ignored
'
engine.Compact("Data Source=; Password =a@3!7f$dQ;")

SqlCeEngine engine = new SqlCeEngine("Data Source = AdventureWorks.sdf");

// Specify null destination connection string for in-place compaction
//
engine.Compact(null);

// Specify connection string for new database options; The following 
// tokens are valid:
//      - Password
//      - LCID
//      - Encrypt
// 
// All other SqlCeConnection.ConnectionString tokens are ignored
//
engine.Compact("Data Source=; Password =a@3!7f$dQ;");

Reference

SqlCeEngine Class

System.Data.SqlServerCe Namespace