DbFile Class Constants, Properties, and Methods Summary

The DbFile class provides the constants listed in the following table.

Constant	Description	Integer Value
BackupOperationEvent	File backup operation event	1001
BackupProgressEvent	File backup progress event	1000
Kind_Control	Control files (that is, _control and _reorg database files)	1
Kind_Environmental	Environmental files (_locks, _environ, and _stats database files)	2
Kind_System	System files (that is, _system, _sysxrf, _sysgui, _sysint, _sysdev, _systools, _jadeapp, _jadedef, and _sysdef database files)	4
Kind_Unknown	Unknown (when detected, raises an exception)	0
Kind_User_Data	User data files (_sindexes.dat, _sindexdefs.dat, and _rootdef database files; and additional database files defined in user schemas)	32
Kind_User_Schema	User schema files (that is, _userscm, _userxrf, _usergui, _userint, and _userdev database files)	8
Kind_Utility	Utility files (that is, _monitor and _rpstrans database files)	16
Mode_ReadOnly	Read-only database file access mode	1
Mode_Update	Update database file access mode	0
Status_Missing	File defined in the schema but does not exist in the database	3
Status_NotAssigned	File not defined in control file	1
Status_NotCreated	File deleted or not yet created	2
Status_Resident	File is resident on disk	4
Status_Unmapped	File in RPS database that is not part of the RPS mapping	5

The DbFile class properties summarized in the following table can be used to develop your database administration user applications.

Property	Description
database	Contains the name of the database
excludeFromBackup	Specifies whether the file is excluded from database backup
kind	Contains the kind, or category, of database file
path	Contains the database file path

The DbFile class methods summarized in the following table can be used to develop your database administration user applications.

Method	Description
backupFile	Backs up a physical database file
certifyFile	Initiates the certification of a database file
changeAccessMode	Changes the access mode of a file to read-only or updateable
compactFile	Initiates the compaction of a database file
getFileLength	Returns the size of a physical database file
getFileStatus	Returns the status of a physical database file during the backup process
getFreeSpace	Evaluates the available free space in a database file

For details, see "DbFile Class", in Chapter 1 of the JADE Encyclopaedia of Classes.

In addition, you can use the Database class getName method to return the name of a database file.