Connection class

Represents a connection to an UltraLite database.

Syntax

public class Connection

Members

All members of Connection class, including all inherited members.

Name	Description
cancelGetNotification method	Cancels any pending get-notification calls on all queues matching the given name.
changeEncryptionKey method	Changes the database encryption key to the new specified key.
close method	Closes this UltraLite database connection.
commit method	Commits outstanding changes to the database.
countUploadRow method	Returns the number of rows that need to be uploaded.
createNotificationQueue method	Creates an event notification queue for this connection.
declareEvent method	Declares an event which can then be registered for and triggered.
destroyNotificationQueue method	Destroys the given event notification queue.
getDatabaseID method	Returns the database ID value used for global autoincrement columns.
getGlobalAutoIncrementUsage method	Returns the percentage of available global autoincrement values that have been used.
getLastDownloadTime method	Returns the time of the last download.
getLastIdentity method	Returns the @identity value.
getNotification method	Reads an event notification.
getNotificationParameter method	Gets a parameter for the event notification just read by GetNotification().
getTable method	Creates and returns a reference to the requested table in the database.
getTableAGDBSet method	Binds to an AGDBSet object using the specified table name.
grantConnectTo method	Creates a new user or changes the password of an existing one.
isOpen method	Checks whether this connection is currently open.
prepareStatement method	Prepares a SQL statement.
registerForEvent method	Registers a queue to receive notifications of an event.
resetLastDownloadTime method	Resets the time of the last download of the named publication.
revokeConnectFrom method	Deletes an existing user.
rollback method	Rolls back outstanding changes to the database.
rollbackPartialDownload method	Rolls back a partial download.
sendNotification method	Send a notification to all queues matching the given name.
setDatabaseID method	Sets the database ID value to be used for global autoincrement columns.
startSynchronizationDelete method	Marks for synchronization all subsequent deletes made by this connection.
stopSynchronizationDelete method	Prevents delete operations from being synchronized.
synchronize method	Synchronizes the database.
synchronizeWithParm method	Synchronizes the database using the specified SyncParms object.
triggerEvent method	Triggers a user-defined event and sends a notification to all registered queues.
validateDatabase method	Validates the database on this connection.
autoCommit variable	Controls whether a commit is performed after each statement (insert, update or delete).
databaseSchema variable	Readonly property; Holds the database schema.
openParms variable	Readonly property; Returns the parameter string used to open this connection.
skipMBASync variable	Controls whether the data synchronization with MobiLink is integrated into the M-Busniess Anywhere synchronization process.
sqlCode variable	Readonly property; Provides error checking capabilities by returning the SQL code value for the success or failure of a database operation.
syncParms variable	Readonly property; Holds the synchronization parameter object of the current connection.
syncResult variable	Readonly property; Holds the synchronization result object of the current connection.

Remarks

Connections are instantiated and opened using DatabaseManager.openConnection.

You must open a connection before carrying out any other operation, and you must close the connection after you have finished all operations on the connection and before your application terminates. You must close all tables opened on a connection before closing the connection.

When a JavaScript Error is thrown because of a failed UltraLite database operation, the SQL error code is set on the sqlCode field of the Connection object.

cancelGetNotification method
changeEncryptionKey method
close method
commit method
countUploadRow method
createNotificationQueue method
declareEvent method
destroyNotificationQueue method
getDatabaseID method
getGlobalAutoIncrementUsage method
getLastDownloadTime method
getLastIdentity method
getNotification method
getNotificationParameter method
getTable method
getTableAGDBSet method
grantConnectTo method
isOpen method
prepareStatement method
registerForEvent method
resetLastDownloadTime method
revokeConnectFrom method
rollback method
rollbackPartialDownload method
sendNotification method
setDatabaseID method
startSynchronizationDelete method
stopSynchronizationDelete method
synchronize method
synchronizeWithParm method
triggerEvent method
validateDatabase method
autoCommit variable
databaseSchema variable
openParms variable
skipMBASync variable
sqlCode variable
syncParms variable
syncResult variable

Discuss this page in DocCommentXchange.