SqlCeEngine Class

Represents the properties, methods, and other objects of the SQL Server Compact Engine object. This class cannot be inherited.


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

Public NotInheritable Class SqlCeEngine _
	Implements IDisposable
Dim instance As SqlCeEngine

The SqlCeEngine type exposes the following members.

Public methodSqlCeEngineInitializes a new instance of the SqlCeEngine class.
Public methodSqlCeEngine(String)Initializes a new instance of the SqlCeEngine class with the specified local connection string.

Public propertyLocalConnectionStringGets or sets the connection string to the SQL Server Compact database.

Public methodCompactReclaims 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.
Public methodCreateDatabaseCreates a new database.
Public methodDisposeReleases all SQL Server Compact SqlCeEngine resources.
Public methodEquals (inherited from Object)
Protected methodFinalize (inherited from Object)
Public methodGetHashCode (inherited from Object)
Public methodGetType (inherited from Object)
Protected methodMemberwiseClone (inherited from Object)
Public methodRepairRepairs a corrupted database.
Public methodShrinkReclaims wasted space in the SQL Server Compact database by moving empty pages to the end of the file, and then truncating the file.
Public methodToString (inherited from Object)
Public methodUpgradeUpgrades a SQL Server Compact database from version 3.5 to 4.0. After the upgrade, the database will be encrypted if the source database was encrypted. If it was not, the upgraded database will be unencrypted.
Public methodUpgrade(String)Upgrades a SQL Server Compact database from version 3.5 to 4.0. The destination database will be encrypted if the encryption mode was specified in the Destination Connection string. The collation of the database will be case sensitive if the case-sensitive property is set to true in the connection string.
Public methodVerifyRecalculates the checksums for each page in the database and compares the new checksums to the expected values.
Public methodVerify(VerifyOption)Verifies the integrity of the database based on the VerifyOption.

SQL Server Compact is optimized to serve as a database for Web sites and Web applications. SQL Server Compact is optimized for use as an embedded database within Web applications. SQL Server Compact can be used as a database for Web sites for multiple users and concurrent data changes.

SQL Server Compact can be used for developing ASP.NET Web applicatons. In the previous versions of SQL Server Compact a flag, SQLServerCompactEditionUnderWebHosting had to be set to use SQL Server Compact in ASP.NET Web applications. The flag is removed in SQL Server Compact 4.0.

The following sample demonstrates how to create a new SQL Server Compact database.

If File.Exists("Test.sdf") Then
End If 
Dim connStr As String = "Data Source = Test.sdf; Password = <password>"

Dim engine As New SqlCeEngine(connStr)

Dim conn As SqlCeConnection = Nothing

   conn = New SqlCeConnection(connStr)

   Dim cmd As SqlCeCommand = conn.CreateCommand()
   cmd.CommandText = "CREATE TABLE myTable (col1 int, col2 ntext)"
End Try

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.