This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

Provider.Instances

persistent class Provider.Instances extends %Library.Persistent, %SYSTEM.Help

SQL Table Name: Provider.Instances

Property Inventory

Method Inventory

Properties

property CacheGroup as %String [ InitialExpression = "cacheusr" ];
Property methods: CacheGroupDisplayToLogical(), CacheGroupGet(), CacheGroupGetStored(), CacheGroupIsValid(), CacheGroupLogicalToDisplay(), CacheGroupLogicalToOdbc(), CacheGroupNormalize(), CacheGroupSet()
property CachePassword as %String [ InitialExpression = "SYS" ];
Property methods: CachePasswordDisplayToLogical(), CachePasswordGet(), CachePasswordGetStored(), CachePasswordIsValid(), CachePasswordLogicalToDisplay(), CachePasswordLogicalToOdbc(), CachePasswordNormalize(), CachePasswordSet()
property CacheUser as %String [ InitialExpression = "cacheusr" ];
Property methods: CacheUserDisplayToLogical(), CacheUserGet(), CacheUserGetStored(), CacheUserIsValid(), CacheUserLogicalToDisplay(), CacheUserLogicalToOdbc(), CacheUserNormalize(), CacheUserSet()
property Description as %String (MAXLEN = 256, MINLEN = 0);
Enter a description
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Directory as %SysPath;
Property methods: DirectoryDisplayToLogical(), DirectoryGet(), DirectoryGetStored(), DirectoryIsValid(), DirectoryLogicalToDisplay(), DirectoryLogicalToOdbc(), DirectoryNormalize(), DirectorySet()
property Error as %String (MAXLEN = 255);
Readable version of Status property.
Property methods: ErrorDisplayToLogical(), ErrorGet(), ErrorGetStored(), ErrorIsValid(), ErrorLogicalToDisplay(), ErrorLogicalToOdbc(), ErrorNormalize(), ErrorSet()
property Installed as %Boolean [ InitialExpression = 0 ];
0 - Not installed 1 - Installed
Property methods: InstalledDisplayToLogical(), InstalledGet(), InstalledGetStored(), InstalledIsValid(), InstalledLogicalToDisplay(), InstalledNormalize(), InstalledSet()
property InstanceName as %String (MAXLEN = 64, MINLEN = 1) [ Required ];
Property methods: InstanceNameDisplayToLogical(), InstanceNameGet(), InstanceNameGetStored(), InstanceNameIsValid(), InstanceNameLogicalToDisplay(), InstanceNameLogicalToOdbc(), InstanceNameLowerCaseDisplayToLogical(), InstanceNameLowerCaseGet(), InstanceNameLowerCaseGetStored(), InstanceNameLowerCaseIsValid(), InstanceNameLowerCaseLogicalToDisplay(), InstanceNameLowerCaseLogicalToOdbc(), InstanceNameLowerCaseNormalize(), InstanceNameNormalize(), InstanceNameSet()
property InstanceNameLowerCase as %String (MAXLEN = 64, MINLEN = 1, XMLPROJECTION = "NONE") [ Required , ReadOnly ];
Property methods: InstanceNameLowerCaseDisplayToLogical(), InstanceNameLowerCaseGet(), InstanceNameLowerCaseGetStored(), InstanceNameLowerCaseIsValid(), InstanceNameLowerCaseLogicalToDisplay(), InstanceNameLowerCaseLogicalToOdbc(), InstanceNameLowerCaseNormalize()
property LastInstall as %String (MAXLEN = 64, MINLEN = 0);
Property methods: LastInstallDisplayToLogical(), LastInstallGet(), LastInstallGetStored(), LastInstallIsValid(), LastInstallLogicalToDisplay(), LastInstallLogicalToOdbc(), LastInstallNormalize(), LastInstallSet(), LastInstallTimeDisplayToLogical(), LastInstallTimeGet(), LastInstallTimeGetStored(), LastInstallTimeIsValid(), LastInstallTimeLogicalToDisplay(), LastInstallTimeLogicalToOdbc(), LastInstallTimeNormalize(), LastInstallUsernameDisplayToLogical(), LastInstallUsernameGet(), LastInstallUsernameGetStored(), LastInstallUsernameIsValid(), LastInstallUsernameLogicalToDisplay(), LastInstallUsernameLogicalToOdbc(), LastInstallUsernameNormalize()
property LastInstallTime as %String (MAXLEN = 64) [ ReadOnly ];
Property methods: LastInstallTimeDisplayToLogical(), LastInstallTimeGet(), LastInstallTimeGetStored(), LastInstallTimeIsValid(), LastInstallTimeLogicalToDisplay(), LastInstallTimeLogicalToOdbc(), LastInstallTimeNormalize()
property LastInstallUsername as %String (MAXLEN = 64) [ ReadOnly ];
Property methods: LastInstallUsernameDisplayToLogical(), LastInstallUsernameGet(), LastInstallUsernameGetStored(), LastInstallUsernameIsValid(), LastInstallUsernameLogicalToDisplay(), LastInstallUsernameLogicalToOdbc(), LastInstallUsernameNormalize()
property MachineName as %String (MAXLEN = 64, MINLEN = 1) [ Required ];
Property methods: MachineNameDisplayToLogical(), MachineNameGet(), MachineNameGetStored(), MachineNameInstanceNameLowerCaseIndexCheck(), MachineNameInstanceNameLowerCaseIndexDelete(), MachineNameInstanceNameLowerCaseIndexExists(), MachineNameInstanceNameLowerCaseIndexOpen(), MachineNameInstanceNameLowerCaseIndexSQLCheckUnique(), MachineNameInstanceNameLowerCaseIndexSQLExists(), MachineNameInstanceNameLowerCaseIndexSQLFindPKeyByConstraint(), MachineNameInstanceNameLowerCaseIndexSQLFindRowIDByConstraint(), MachineNameIsValid(), MachineNameLogicalToDisplay(), MachineNameLogicalToOdbc(), MachineNameLowerCaseDisplayToLogical(), MachineNameLowerCaseGet(), MachineNameLowerCaseGetStored(), MachineNameLowerCaseIsValid(), MachineNameLowerCaseLogicalToDisplay(), MachineNameLowerCaseLogicalToOdbc(), MachineNameLowerCaseNormalize(), MachineNameNormalize(), MachineNameSet()
property MachineNameLowerCase as %String (MAXLEN = 64, MINLEN = 1, XMLPROJECTION = "NONE") [ Required , ReadOnly ];
Property methods: MachineNameLowerCaseDisplayToLogical(), MachineNameLowerCaseGet(), MachineNameLowerCaseGetStored(), MachineNameLowerCaseIsValid(), MachineNameLowerCaseLogicalToDisplay(), MachineNameLowerCaseLogicalToOdbc(), MachineNameLowerCaseNormalize()
property ManagerGroup as %String [ InitialExpression = "root" ];
Property methods: ManagerGroupDisplayToLogical(), ManagerGroupGet(), ManagerGroupGetStored(), ManagerGroupIsValid(), ManagerGroupLogicalToDisplay(), ManagerGroupLogicalToOdbc(), ManagerGroupNormalize(), ManagerGroupSet()
property SecurityType as %String [ InitialExpression = "Minimal" ];
Property methods: SecurityTypeDisplayToLogical(), SecurityTypeGet(), SecurityTypeGetStored(), SecurityTypeIsValid(), SecurityTypeLogicalToDisplay(), SecurityTypeLogicalToOdbc(), SecurityTypeNormalize(), SecurityTypeSet()
property State as %String [ InitialExpression = "Uninstalled" ];
Property methods: StateDisplayToLogical(), StateGet(), StateGetStored(), StateIsValid(), StateLogicalToDisplay(), StateLogicalToOdbc(), StateNormalize(), StateSet()
property Status as %Status [ InitialExpression = $$$OK ];
Property methods: StatusGet(), StatusGetStored(), StatusIsValid(), StatusLogicalToOdbc(), StatusSet()
property Unicode as %Boolean [ InitialExpression = 1 ];
Property methods: UnicodeDisplayToLogical(), UnicodeGet(), UnicodeGetStored(), UnicodeIsValid(), UnicodeLogicalToDisplay(), UnicodeNormalize(), UnicodeSet()

Methods

classmethod Create(MachineName As %String, InstanceName As %String, ByRef Properties As %String) as %Status
classmethod Delete(MachineName As %String, InstanceName As %String) as %Status
classmethod Exists(MachineName As %String, InstanceName As %String, ByRef Instance As %ObjectHandle, ByRef Status As %Status) as %Boolean
Instance exists.
This method checks for the existence of an Event in the security database.
Parameters:
Source - Source of the Event. This may also contain an entire Event specificationin the format Source/Type/Name. If this is the case the Type and Name parameters are ignored.
Type - Type of the Event
Name - Name of the Event
Return values:
If Value of the method = 0 (Event does not exist, or some error occured)
Event = Null
Status = Event "x" does not exist, or other error message

If Value of the method = 1 (Event exists)
Event = Object handle to Event
Status = $$$OK
classmethod Get(MachineName As %String, InstanceName As %String, ByRef Properties As %String) as %Status
classmethod Install(MachineName As %String, InstanceName As %String) as %Status
classmethod Modify(MachineName As %String, InstanceName As %String, ByRef Properties As %String) as %Status
classmethod Remove(MachineName As %String, InstanceName As %String) as %Status

Queries

query List(Names As %String)
Selects MachineName As %String, InstanceName As %String, Directory As %String, Description As %String, LastInstall As %String, LastInstallTime As %String, LastInstallUsername As %String, State As %String, Status As %String, Error As %String, CacheGroup As %String, CacheUser As %String, ManagerGroup As %String, SecurityType As %String, Unicode As %Boolean
List Instances.

Parameters:
Names - Comma separated list of Device names
"*" - All records match
"String,String1" - Any records matching one of these elements
"String*" - Any record starting with "String"
"String,String1*,String2" - Any record mathing one of these elements, or starting with "String1"
Note: This query may change in future versions

Indexes

index (MachineNameInstanceNameLowerCaseIndex on MachineNameLowerCase,InstanceNameLowerCase) [IdKey, Type = key, Unique];
Index methods: MachineNameInstanceNameLowerCaseIndexCheck(), MachineNameInstanceNameLowerCaseIndexDelete(), MachineNameInstanceNameLowerCaseIndexExists(), MachineNameInstanceNameLowerCaseIndexOpen(), MachineNameInstanceNameLowerCaseIndexSQLCheckUnique(), MachineNameInstanceNameLowerCaseIndexSQLExists(), MachineNameInstanceNameLowerCaseIndexSQLFindPKeyByConstraint(), MachineNameInstanceNameLowerCaseIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (Provider.Instances)

^Provider("InstancesD")(ID)
=
CacheGroup
CachePassword
CacheUser
Description
Directory
Error
Installed
InstanceName
LastInstall
LastInstallTime
LastInstallUsername
MachineName
ManagerGroup
SecurityType
State
Status
Unicode
Feedback