Description

McDBDatabases instances are collections of database definitions and instances available for use through the IQbase Database Engine (McDBLib).

Object Model

Remarks

McDBDatabases is a memory object only, and its contents may be freely changed and may or may not be representative of the contents of the actual configuration file (McDBLib.Cfg). Although operations on this collection may effect changes in the configuration file, not all operations that change this object will have a corresponding effect on the configuration file. For instance, the Create and Add methods add instances to this collection and add corresponding entries, as necessary, to the configuration file. However, the Remove and RemoveAll methods may remove instances from this collection but will NOT remove definitions from the configuration file. Similarly, the RemoveConfiguration method will alter the configuration file, but has no effect on the McDBDatabase instances in this collection.

Members

Methods
Add

Adds a new database definition (i.e. mapping) to this McDBDatabases collection and returns its corresponding McDBDatabase instance.

Create

Create a new McDBDatabase, both mapping and files, in this McDBDatabases collection.

CreateNodes

Create an McDBNodes object

CreateQuery

Returns an McDBQuery instance initialized to query the McDBNode instances in open databases represented by this McDBDatabases collection.

Populate

Populate this McDBDatabases with all of the persistent mappings in the local configuration file (McDBLib.Cfg).

Remove

Remove an McDBDatabase defintion (mapping) from this McDBDatabases collection.

RemoveAll

Clears all database definitions from this McDBDatabases collection.

RemoveConfiguration

Remove the entries for a particular configuration from the local database configuration file (McDBLib.Cfg).

RetrieveNode

Return an McDBNode with a given global specifier.


Properties
CountRead-only property

The number of McDBDatabase instances defined in this McDBDatabases collection.

GeneratesEventsRead-write property

Indicate which events are broadcast by this McDBDatabase object and the McDBDatabase objects spawned from it.

ItemRead-only property

Return a particular McDBDatabase instance from this McDBDatabases collection.

SaveLoginCredentialsRead-write property

Remember and use last successful login credentials as parameters to subsequent calls of McDBDatabase.Open.

TransactionsRead-only property

A McDBTransactions object containing all of the McDBTransaction instances allocated.


Events
Action

This event is fired as an McDBQuery progresses. A percentage of completion is also provided by this event.

AfterDatabaseDelete

This event is fired after an McDBDatabase has been deleted.

AfterNodeDelete

This event is fired after an McDBNode instance is deleted from its McDBDatabase.

BeforeDatabaseDelete

This event is fired when an McDBDatabase is about to be deleted.

BeforeNodeDelete

This event is fired when an McDBNode instance is about to be deleted from its McDBDatabase.

BeginAction

This event is fired when an McDBQuery begins executing.

DatabaseClose

This event is fired when an McDBDatabase is closed.

DatabaseCreate

This event is fired when a new McDBDatabase is created (i.e. the disk file(s) representing a new McDBDatabase are generated).

DatabaseLogin

This event is fired when authorization information is required to open or access a secure McDBDatabase.

DatabaseOpen

This event is fired when an McDBDatabase is opened.

DatabaseSecurityChanged

This event is fired after a security change occurs that requires user logout/login to process occurs.

EndAction

This event is fired when an McDBQuery completes.

Error

This event is fired when a severe framework error occurs. The action to take may be provided as a return argument.

Information

This event is fired as administrative actions on an McDBDatabase complete, such as a schemata update or repair.

NodeActivate

This event is fired when an McDBDatabase.ActiveNode property changes.

NodeCreated

This event is fired whenever an McDBNode is created.

NodeLocked

This event is fired when an McDBNode instance is locked, either internally by a pending McDBTransaction (for data integrity) or explicitly (by locking the object in another thread/process).

NodeModified

This event is fired whenever an McDBNode instance is stored/updated. This event does not necessarily require a modification, just a database store event. This event also uses the mcdbModifyContext parameter to limit the scope of the modification(s) encapsulated by the notification. If the event is triggered by another database client, the context parameter will be either mcdbNodeAttribute or mcdbNotNodeAttribute. No additional granularity is available in this condition. This event also provides a varaint parameter containing the string name of the property/attribute that changed when the mcdbModifyContext is for one of these contexts is set. If more than one property or attribute or a combination of property(ies) and attribute(s) are changed in the same 1-second event “cycle”, this ContextName will be Empty.

NodeUnlocked

This event is fired when an McDBNode instance lock, as described in McDBDatabase.NodeLocked, is released.

TypeModified

This event is fired when an McDBType object is stored/saved, although not necessarily changed.

TypesChanged

This event is fired when an McDBType object is added or deleted.