Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [Config] >  [Configuration]
Private  Storage   

abstract class Config.Configuration extends %SYSTEM.Help

This class and all its methods are deprecated. See the remaining Config classes to manipulate individual sections in the iris.cpf file.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
31


Summary

Methods
Activate AddDataServer AddDatabase AddDevice
AddGlobalMapping AddNamespace CPFImport CreateDatabase
DeleteDatabase GetDataServer GetDatabase GetDevice
GetGlobalMapping GetNamespace Help ModifyDataServer
ModifyDatabase ModifyDevice ModifyGlobalMapping ModifyNamespace
RemoveDataServer RemoveDatabase RemoveDevice RemoveGlobalMapping
RemoveNamespace StartupConfiguration


Methods

• classmethod Activate() as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.CPF.Activate() method instead.
• classmethod AddDataServer(Name As %String, Address As %String = "", Port As %Integer = 1972, IsMirrorConnection As %Boolean = 0) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.ECPServers.Create() method instead.
• classmethod AddDatabase(Name As DBName, Directory As %String, Server As %String = "", MountAtStartup As %Boolean = 0, ClusterMountMode As %Boolean = 0, MountRequired As %Boolean = 0) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Databases.Create() method instead.
• classmethod AddDevice(Name As %String, PhysicalDevice As %String = "", Type As %String = "", SubType As %String = "", Prompt As %String = "", OpenParameters As %String = "", AlternateDevice As %String = "", Description As %String = "", Alias As %String = "") as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Devices.Create() method instead.
• classmethod AddGlobalMapping(Namespace As NSName, Global As %String, Subscript As %String = "", DataLocation As %String, LockLocation As %String = "", Collation As %Integer = 5, SLMLocation As %String = "") as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.MapGlobals.Create() method instead.
• classmethod AddNamespace(Name As NSName, Globals As DBName, Routines As DBName, SysGlobals As DBName = "IRISSYS", SysRoutines As DBName = "IRISSYS", Library As DBName = "IRISLIB", TempGlobals As DBName = "IRISTEMP", Description As %String = "") as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Namespaces.Create() method instead.
• classmethod CPFImport(CPFFile As %String = "") as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.CPF.Activate() method instead.
This method currently performs no action, and returns 1 as its status.
CPF activation methods only work with the CPF file which was originally activated starting with version 2009.1. Changes can be made to the activated CPF file, and then activated by the Config.CPF.Activate() method. You cannot import a differently named CPF file and activate it. The naming of which CPF file to use only happens at system startup. An alternate method to activate a different CPF file is to to copy the entire file which you want to activate into the one which is currently activated, and then call Config.CPF.Activate(). For example if c:\iris\iris.cpf is active:

s x=##Class(%Library.File).CopyFile("c:\iris\iris.cpf_backup","c:\iris\iris.cpf")
s x=##Class(Config.CPF).Activate()
• classmethod CreateDatabase(Name As DBName, Directory As %String, Size As %Integer = 1, BlockSize As %Integer = 8192, MountAtStartup As %Boolean = 0, ClusterMountMode As %Boolean = 0, MountRequired As %Boolean = 0, EncryptedDB As %Boolean = 0, Resource As %String = "%DB_%DEFAULT", GlobalJournalState As %Integer) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Databases.Create(), and SYS.Database.CreateDatabase() instead.
• classmethod DeleteDatabase(Name As DBName) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Databases.Delete() and SYS.Databases.DeleteDatabase() methods instead.
• classmethod GetDataServer(Name As %String = "", ByRef Address As %String, ByRef Port As %Integer) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.ECPServers.Get() method instead.
• classmethod GetDatabase(Name As DBName, ByRef Directory As %String, ByRef Server As %String, ByRef MountAtStartup As %Boolean, ByRef ClusterMountMode As %Boolean, ByRef MountRequired As %Boolean) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Databases.Get() method instead.
• classmethod GetDevice(Name As %String, ByRef PhysicalDevice As %String, ByRef Type As %String, ByRef SubType As %String, ByRef Prompt As %String, ByRef OpenParameters As %String, ByRef AlternateDevice As %String, ByRef Description As %String, ByRef Alias As %String) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Devices.Get() method instead.
• classmethod GetGlobalMapping(Namespace As NSName, Global As %String, Subscript As %String, ByRef Database As %String, ByRef LockDatabase As %String, ByRef Collation As %Integer, ByRef SLMLocation As %String) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.MapGlobals.Get() method instead.
• classmethod GetNamespace(Name As NSName, ByRef Globals As DBName, ByRef Routines As DBName, ByRef SysGlobals As DBName, ByRef SysRoutines As DBName, ByRef Library As DBName, ByRef TempGlobals As DBName) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Namespaces.Get() method instead.
• classmethod ModifyDataServer(Name As %String, Address As %String, Port As %Integer) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.ECPServers.Modify() method instead.
• classmethod ModifyDatabase(Name As DBName, Directory As %String, Server As %String, MountAtStartup As %Boolean, ClusterMountMode As %Boolean, MountRequired As %Boolean) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Databases.Modify() method instead.
• classmethod ModifyDevice(Name As %String, PhysicalDevice As %String, Type As %String, SubType As %String, Prompt As %String, OpenParameters As %String, AlternateDevice As %String, Description As %String, Alias As %String) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Devices.Modfy() method instead.
• classmethod ModifyGlobalMapping(Namespace As NSName, Global As %String, Subscript As %String, DataLocation As %String, LockLocation As %String, Collation As %Integer, SLMLocation As %String) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.MapGlobals.Modify() method instead.
• classmethod ModifyNamespace(Name As NSName, Globals As DBName, Routines As DBName, SysGlobals As DBName, SysRoutines As DBName, Library As DBName, TempGlobals As DBName) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Namespaces.Modify() method instead.
• classmethod RemoveDataServer(Name As %String) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.ECPServers.Delete() method instead.
• classmethod RemoveDatabase(Name As DBName) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Databases.Delete() method instead.
• classmethod RemoveDevice(Name As %String) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Devices.Delete() method instead.
• classmethod RemoveGlobalMapping(Namespace As NSName, Global As %String, Subscript As %String) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.MapGlobals.Delete() method instead.
• classmethod RemoveNamespace(Name As NSName) as %Status
This method is DEPRECATED and will be removed in a future version.
Use Config.Namespaces.Delete() method instead.
• classmethod StartupConfiguration() as %Status
This method is DEPRECATED and will be removed in a future version.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.