Skip to main content

Databases (Tools/APIs)

Manage database files programmatically (disable and enable journaling, copy, configure, and so on).

Background Information

InterSystems IRIS® data platform stores data and code in database files. For an introduction, see Namespaces and Databases.

Typically you create and configure databases via the Management Portal. See Configuring Databases.

Available Tools

Represents InterSystems IRIS database files, as configured in an instance of InterSystems IRIS. Properties of this class specify configuration details for that database as well as current read-only details such as size and last expansion time.

Methods in this class enable you to work with database files. These methods include:

  • Copy()

  • DisableJournaling()

  • EnableJournaling()

  • GetDatabaseFreeSpace()

  • And others

This class also provides queries that provide information about databases. These queries include:

  • FreeSpace()

  • List()

  • RemoteDatabaseList()

  • And others

Availability: %SYS namespace.

Enables you to modify and obtain information about the [Databases] section of the CPF. (Note that you usually perform this configuration via the Management Portal, as noted above.)

The class also provides the List() and MirrorDatabaseList() class queries.

The class documentation includes examples and details.

Availability: %SYS namespace.

%Installer.ManifestOpens in a new tab class and other classes in the %Installer package

Enable you to define and use an installation manifest. Among other tasks, you can configure databases and namespaces.

Availability: All namespaces.

^DATABASE routine

This routine provides ways to manage databases; it is an alternative to using the Management Portal. For details, see ^DATABASE.

Availability: %SYS namespace.

See Also

FeedbackOpens in a new tab