DBC CLOSEDATA

From Recital Documentation Wiki
Jump to: navigation, search

Purpose

Database event triggered by the closure of a database


Syntax

PROCEDURE dbc_CloseData(<expC>,<expL1>)

// Commands

ENDPROC | RETURN [<expL2>]


or

PROCEDURE dbc_CloseData

LPARAMETERS [<expC>,<expL1>]

// Commands

ENDPROC | RETURN [<expL2>]


See Also

ADATABASES(), ALTER TABLE, ADD TABLE, ALTER INDEX, BACKUP DATABASE, CLOSE DATABASES, CLOSE TABLES, COMPILE DATABASE, CREATE DATABASE, CREATE TABLE, CREATE INDEX, CREATE VIEW, DATABASE(), DATABASE EVENTS, DB_DATADIR, DBUSED(), DISPLAY DATABASE, DISPLAY INDEXES, DISPLAY TABLES, DROP DATABASE, DROP INDEX, DROP TABLE, GETENV(), LIST DATABASE, LIST INDEXES, LIST TABLES, OPEN DATABASE, PACK DATABASE, REBUILD DATABASE, REINDEX DATABASE, RESTORE DATABASE, SET AUTOCATALOG, SET EXCLUSIVE, USE


Description

The DBC_CLOSEDATA database event is triggered by the closure of a database. The associated code is run before the database is actually closed. Databases are closed using the CLOSE DATABASES command.


Event Description
<expC> The database name
<expL1> Specifies whether the ALL keyword was included on the CLOSE DATABASES, .T. or not, .F.
<expL2> If the dbc_closedata procedure returns .F., the database is not closed, if .T., the close operation continues


Databases in Recital are implemented as directories containing files that correspond to the tables and associated files in the database. Operating System file protection can be applied individually to the files for added security. The directories are sub-directories of the Recital data directory. The environment variable DB_DATADIR points to the current Recital data directory and can be queried using the GETENV() function. Files from other directories can be added to the database using the ADD TABLE command or via the database catalog and SET AUTOCATALOG functionality.

Programs associated with database events should reside in the DB_DATADIR sub-directory for the relevant database.


Example

procedure dbc_closedata
lparameters cName, lAll
close procedures
return


Products

Recital, Recital Server