ModifyDatabase

Modify an existing database.

Synopsis

[Actions]   ModifyDatabase:Name=DatabaseName,Directory=DatabaseDirectory[,Additional Properties]

Where you substitute [,Additional Properties] for the additional properties you want to modify. ModifyDatabase can modify logical database properties and the physical database properties listed below:

Size
MaxSize
ExpansionSize
ResourceName
GlobalJournalState
NewGlobalIsKeep
NewGlobalCollation
ReadOnly

Description

ModifyDatabase specifies changes to make to a database. InterSystems IRIS® modifies the specified database when processing the [Actions] section during a configuration merge.

You can specify physical and logical database properties in the ModifyDatabase definition. During the merge, InterSystems IRIS runs an API call and then runs Config.Databases.Modify()Opens in a new tab to modify the database as specified by ModifyDatabase. The complete list of database properties is available in the class reference.

If you want to only modify logical database properties with ModifyDatabase, you can supply the optional LogicalOnly (1 or 0) property. When set to 1, this suppresses the API call that modifies physical database properties.

Changing This Operation

This operation is designed to be used during a configuration merge. You can change ModifyDatabase by editing the merge file in a text editor (as described in Editing the Active CPF).

For information about modifying a database from the Management Portal, see Configuring Databases.

CreateDatabaseFile

DeleteDatabase