ULConnectionStringBuilder class

Builds a connection string for opening a connection to an UltraLite database.

Visual Basic syntax

Public NotInheritable Class ULConnectionStringBuilder
    Inherits System.Data.Common.DbConnectionStringBuilder

C# syntax

public sealed class ULConnectionStringBuilder : 
    System.Data.Common.DbConnectionStringBuilder

Members

All members of ULConnectionStringBuilder class, including all inherited members.

Name	Description
ULConnectionStringBuilder constructor	Initializes a ULConnectionStringBuilder instance with its default values.
Add method (Inherited from System.Data.Common.DbConnectionStringBuilder)	Adds an entry with the specified key and value into the System.Data.Common.DbConnectionStringBuilder.
AppendKeyValuePair method (Inherited from System.Data.Common.DbConnectionStringBuilder)	Provides an efficient and safe way to append a key and value to an existing System.Text.StringBuilder object.
Clear method (Inherited from System.Data.Common.DbConnectionStringBuilder)	Clears the contents of the System.Data.Common.DbConnectionStringBuilder instance.
ClearPropertyDescriptors method (Inherited from System.Data.Common.DbConnectionStringBuilder)	Clears the collection of System.ComponentModel.PropertyDescriptor objects on the associated System.Data.Common.DbConnectionStringBuilder.
ContainsKey method	Determines whether the ULConnectionStringBuilder object contains a specific keyword.
EquivalentTo method	Compares the connection information in this ULConnectionStringBuilder object with the connection information in the supplied DbConnectionStringBuilder object.
GetProperties method (Inherited from System.Data.Common.DbConnectionStringBuilder)	Fills a supplied System.Collections.Hashtable with information about all the properties of this System.Data.Common.DbConnectionStringBuilder.
GetShortName method	Retrieves the short version of the supplied keyword.
Remove method	Removes the entry with the specified key from the ULConnectionStringBuilder instance.
ShouldSerialize method (Inherited from System.Data.Common.DbConnectionStringBuilder)	Indicates whether the specified key exists in this System.Data.Common.DbConnectionStringBuilder instance.
ToString method (Inherited from System.Data.Common.DbConnectionStringBuilder)	Returns the connection string associated with this System.Data.Common.DbConnectionStringBuilder.
TryGetValue method	Retrieves a value corresponding to the supplied key from this ULConnectionStringBuilder.
BrowsableConnectionString property (Inherited from System.Data.Common.DbConnectionStringBuilder)	Gets or sets a value that indicates whether the System.Data.Common.DbConnectionStringBuilder.ConnectionString property is visible in Visual Studio designers.
CacheSize property	UL Ext: Specifies the size of the cache.
ConnectionName property	Specifies a name for the connection.
ConnectionString property (Inherited from System.Data.Common.DbConnectionStringBuilder)	Gets or sets the connection string associated with the System.Data.Common.DbConnectionStringBuilder.
Count property (Inherited from System.Data.Common.DbConnectionStringBuilder)	Gets the current number of keys that are contained within the System.Data.Common.DbConnectionStringBuilder.ConnectionString property.
DatabaseKey property	Specifies a key for encrypting the database.
DatabaseName property	Specifies a name for the database or the name of a loaded database to which a connection needs to be made.
DatabaseOnDesktop property	UL Ext: Specifies the path and file name of the UltraLite database on Windows desktop platforms.
DatabaseOnDevice property	UL Ext: Specifies the path and file name of the UltraLite database on Windows Mobile.
IsFixedSize property (Inherited from System.Data.Common.DbConnectionStringBuilder)	Gets a value that indicates whether the System.Data.Common.DbConnectionStringBuilder has a fixed size.
IsReadOnly property (Inherited from System.Data.Common.DbConnectionStringBuilder)	Gets a value that indicates whether the System.Data.Common.DbConnectionStringBuilder is read-only.
Keys property (Inherited from System.Data.Common.DbConnectionStringBuilder)	Gets an System.Collections.ICollection that contains the keys in the System.Data.Common.DbConnectionStringBuilder.
OrderedTableScans property	Specifies whether SQL queries without ORDER BY clauses should perform ordered table scans by default.
Password property	Specifies the password for the authenticated user.
ReserveSize property	UL Ext: Specifies the reserve file system space for storage of UltraLite persistent data.
StartLine property	Specifies the location and then starts the UltraLite engine.
this property	Specifies the value of the specified connection keyword.
UserID property	Specifies an authenticated user for the database.
Values property (Inherited from System.Data.Common.DbConnectionStringBuilder)	Gets an System.Collections.ICollection that contains the values in the System.Data.Common.DbConnectionStringBuilder.

Remarks

The frequently-used connection parameters are individual properties on the ULConnectionStringBuilder object.

The ULConnectionStringBuilder class is not available in the .NET Compact Framework 2.0.

A ULConnectionStringBuilder object is used to specify the parameters for opening a connection (ULConnection.Open) or dropping a database (ULDatabaseManager.DropDatabase).

Leading and trailing spaces are ignored in all values. Values must not contain leading or trailing spaces, or a semicolon, or begin with either a single quote or a double quote.

When building a connection string, you need to identify the database and specify any optional connection settings. Once you have supplied all the connection parameters by setting the appropriate properties on a ULConnectionStringBuilder object, you create a connection string using the System.Data.Common.DbConnectionStringBuilder.ConnectionString. The resulting string is used to create a new ULConnection with the ULConnection(String) constructor or set the ULConnection.ConnectionString of an existing ULConnection object.

Identifying the database

Each instance contains platform-specific paths to the database. Only the value corresponding to the executing platform is used. For example, in the code below the path \UltraLite\mydb1.udb would be used on Windows Mobile, while mydb2.db would be used on other platforms.

' Visual Basic
Dim dbName As ULConnectionStringBuilder = _
    new ULConnectionStringBuilder
dbName.DatabaseOnDevice = "\UltraLite\mydb1.udb"
dbName.DatabaseOnDesktop = "somedir\mydb2.udb"

The following code is the C# language equivalent:

// C#
ULConnectionStringBuilder dbName = new ULConnectionStringBuilder();
dbName.DatabaseOnDevice = "\\UltraLite\\mydb1.udb";
 dbName.DatabaseOnDesktop = @"somedir\\mydb2.udb";

The recommended extension for UltraLite database files is .udb. On Windows Mobile devices, the default database is \UltraLiteDB\ulstore.udb. On other Windows platforms, the default database is ulstore.udb. In C#, you must escape any backslash characters in paths or use @-quoted string literals.

If you are using multiple databases, you must specify a database name for each database.

Optional connection settings

Depending on your application's needs and how the database was created, you might need to supply a non-default ULConnectionStringBuilder.UserID and ULConnectionStringBuilder.Password, a database ULConnectionStringBuilder.DatabaseKey, and the connection ULConnectionStringBuilder.CacheSize. If your application is using multiple connections, you should provide a unique ULConnectionStringBuilder.ConnectionName for each connection.

Databases are created with a single authenticated user, DBA, whose initial password is sql. By default, connections are opened using the user ID DBA and password sql. To disable the default user, use the ULConnection.RevokeConnectFrom. To add a user or change a user's password, use the ULConnection.GrantConnectTo.

If an encryption key was supplied when the database was created, all subsequent connections to the database must use the same encryption key. To change a database's encryption key, use the ULConnection.ChangeEncryptionKey.

For more information, see UltraLite connection parameters.