Skip to main content

This is documentation for Caché and Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

Please read this important announcement about the future of Caché and Ensemble maintenanceOpens in a new tab. Contact your account team to migrate to InterSystems IRIS.

Database

Define Caché databases.

Synopsis

[Databases]    Name=a,b,c,d,e, f

Description

Each entry has up to six comma-separated arguments that define a database. The only argument that is required is the first, the directory specification. If the other arguments are not specified, then the default is used. From left to right:

  • Full directory specification for database file. Required.

  • Remote system name (empty for local system). If the system is remote (non-empty name), subsequent fields are ignored. Default is the local system.

  • Must mount at startup. 0 – Database is not mounted at startup (default). 1 – Database must be mounted at startup, or startup fails.

  • Cluster mount mode – 0 – Private mount (default), 1 – cluster mount (valid only for clustered systems.)

  • Mount at startup – 0 – Database is mounted when first accessed (default), 1 database attempts to be mounted at startup. If it fails, startup continues. Valid only for cluster databases; ignored for non-cluster databases. (To mount non-cluster databases at startup, use the third value, the Must mount at startup flag. Or mount the database explicitly in the ^%ZSTART routine using the SYS.DatabaseOpens in a new tab class.

  • Stream Location. Directory where the streams associated with this database go. The default is blank — "" (which InterSystems recommends.) This default location is in the subdirectory stream, underneath the database directory. For example, for a database located in c:\abc, the default stream location is c:\abc\stream.

By default even if they are not specified, the CACHESYS, CACHELIB, CACHETEMP, and CACHEAUDIT databases must be local to the system, private mounted, and mount required at startup.

Examples

In the [Databases] section, each line is a database with arguments Name=a,b,c,d,e,f. Here is an example from Windows:

[Databases]
CACHESYS=c:\cache\mgr\
CACHELIB=c:\cache\mgr\cachelib\
CACHETEMP=c:\cache\mgr\cachetemp\
CACHEAUDIT=c:\cache\mgr\cacheaudit\
DOCBOOK=c:\cache\mgr\docbook\
SAMPLES=c:\cache\mgr\samples\
USER=c:\cache\mgr\user\
SALES=c:\sales\,SALESERVER 
; Database is on system SALESERVER
BILLING=/usr/billing/,,1                    
; Database is local and mount required
CLUSTER=dka300:[cluster],,,1      ; Database is cluster mounted

Example of remote databases without mirroring:

PRDAUDIT=c:\cache\mgr\prdaudit\,PRD
PRDDCIFC=\cache\mgr\prddata\,PRD
PRDERR=\cache\mgr\prderr\,,1

Example of remote databases with mirroring. Note in this mirrored example the two remote databases, both mirrored and non-mirrored, are formatted differently than they would be in a non-mirrored environment. 

PRDAUDIT=:mirror:PRDMIRROR:PRDAUDIT,PRD - Mirrored remote database
PRDDCIFC=:ds:PRDDCIFC,PRD - Non-mirrored remote database
PRDERR=\cache\mgr\prderr\,,1 - Local database
Range of Values

As described above.

Management Portal

On the page System Administration > Configuration > System Configuration > Local Databases, to add a new entry, select Create New Database. To edit an existing entry, select Edit in that entry's row.


FeedbackOpens in a new tab