Description

McDBDatabase objects represent database definitions and the instance defined by that defintion's current state.

Object Model








Remarks

Since McDBDatabase objects are capable of representing any of the states of a an actual database, the database instance represented by an McDBDatabase may be either valid or invalid, open or closed, and have any allowable name and path, among other defining characterstics. McDBDatabase objects are the containers for all database objects and are the source for all events fired from McDBLib.

Members

Methods
Close

Close this McDBDatabase.

CreateQuery

Returns an McDBQuery instance initialized to query the McDBNode instances in this McDBDatabase.

Delete

This method will delete this McDBDatabase, when possible. This McDBDatabase must not be open and the backing file system files must be deletable for this operation to succeed.

DisableSecurity

Disable security on this McDBDatabase.

EnableSecurity

Activate Security on this McDBDatabase.

Open

Open this McDBDatabase.

RetrieveNode

Return an McDBNode in this McDBDatabase with a given global specifier.

VerifyLogin

Verify the password of the McDBDatabase.LoggedUser.


Properties
ActiveNodeRead-write property

The McDBNode instance that is “active” within this McDBDatabase.

CategoriesRead-only property

A McDBCategories collection of all the category/flag defintions in this database.

ConfigStringRead-write property

Each open McDBDatabase instance is associated with entries from the local configuration file (McDBLib.Cfg), defining the logical name of the McDBDatabase and its local (or logical remote) Path, along with any number of configuation strings managed and used solely by the database engine. This property will assign and retrieve these values.

GroupsRead-only property

A collection of all the McDBGroup instances in this McDBDatabase.

IsAvailableForBackupRead-write property

Whether the files of this McDBDatabase are unlocked (available for backup by another program).

IsOpenRead-only property

Whether this McDBDatabase is currently open.

IsReadOnlyRead-write property

Whether this database (and objects read from it) are Read only. By default this property is False (i.e. databases are opened for both read and write access).

IsSecureRead-only property

Whether security is enabled on this McDBDatabase.

LoggedUserRead-only property

The McDBUser that opened this McDBDatabase.

NameRead-only property

The logical name of this McDBDatabase.

PathRead-only property

The local file system path to the files containing this McDBDatabase.

RootNodeRead-only property

The McDBNode instance representing the root this McDBDatabase's McDBNode tree hierarchy.

ServerRead-only property

The DNS name or IP Address of the Server where this McDBDatabase is located.

TypesRead-only property

A McDBTypes collection of the object type (McDBType) defintions in this McDBDatabase.

UsersRead-only property

The collection of McDBUser instances (valid logins) for this McDBDatabase.


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.