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

persistent class Security.DocDBs extends %Persistent, %XML.Adaptor, %SYSTEM.Help

The table for this class should be manipulated only through object access, the published API's or through the System Management Portal. It should not be updated through direct SQL access.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 17 1 1


Summary

Properties
Description Enabled Name Namespace Resource

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PhysicalAddress %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %ValidateIndices %ValidateObject CheckAdmin
Create Delete DeleteAllInNamespace Exists
Export Get Help Import
Modify XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Properties

• property Description as %String(MAXLEN=256);
Description of the Doc DB.
• property Enabled as Security.Datatype.BooleanYN [ InitialExpression = 1,Required ];
Doc DB enabled.
• property Name as %Dictionary.Classname;
Name of the Doc DB.
• property Namespace as %String(MAXLEN=64,MINLEN=1);
• property Resource as %String(MAXLEN=64,MINLEN=0);

Methods

• classmethod CheckAdmin() as %Status
• classmethod Create(Name As %String, Namespace As %String, ByRef Properties As %String) as %Status
Create a Doc DB.
Create a Doc DB in the Security database.
Parameters:
Name - Name of the Doc DB
Namespace - Namespace of location of the Doc DB Description - Description of the Doc DB
Enabled - Enabled for auditing - 0/1
Resource - Resource controlling the Doc DB.
• classmethod Delete(Name As %String, Namespace As %String) as %Status
Delete a Doc DB.
This method will delete an Doc DB from the security database.
Parameters:
Name - Name of the Doc DB
Namespace - Namespace of the DOC DB
This method also clears the in memory counters.
• classmethod DeleteAllInNamespace(Namespace As %String = "", ByRef Deleted As %String) as %Status
• classmethod Exists(Name As %String = "", Namespace As %String = "", ByRef DocDB As %ObjectHandle, ByRef Status As %Status) as %Boolean
Doc DB exists.
This method checks for the existence of a Doc DB in the security database.
Parameters:
Name - Name of the Doc DB
Namespace - Namespace of the Doc DB Return values:
If Value of the method = 0 (Doc DB does not exist, or some error occured)
DocDB = Null
Status = Doc DB "x" does not exist, or other error message

If Value of the method = 1 (Doc DB exists)
Doc DB = Object handle to Doc DB
Status = $$$OK
• classmethod Export(FileName As %String = "DocDBsExport.xml", ByRef NumExported As %Integer, Names As %String = "*", Namespaces As %String = "*") as %Status
This method exports Doc DB records to a file in xml format.
Parameters:
Filename - Output file name
NumExported (byref) - Returns number of records exported.
Names - Comma separated list of Doc DBs to export, "*" = All
Namespaces - Comma separated list of Namespaces to export, "*" = All
• classmethod Get(Name As %String, Namespace As %String, ByRef Properties As %String) as %Status
Get a Doc DBs properties.
Gets a Doc DBs properties from the security database.
Parameters:
Name - Name of the Doc DB
namespace - Namespace of the Doc DB
Return values:
Properties - Array of properties
"Description" - Description of the Doc DB
"Enabled" - Doc DB is enabled
"Resource" - Resource of the Doc DB
• classmethod Import(FileName As %String = "DocDBsExport.xml", ByRef NumImported As %Integer, Flags As %Integer = 0) as %Status
Import Doc DB records from an xml file.
Parameters:
FileName - Filename to import Doc DB records from
NumImported (byref) - Returns number of records imported
Flags - Control import
Bit 0 - Do not import records, just return count
Note: On failure, no records will be imported
• classmethod Modify(Name As %String = "", Namespace As %String = "", ByRef Properties As %String) as %Status
Modify a Doc DBs properties.
Modifies a Doc DBs properties from the security database.
Parameters:
Name - Name of the Doc DB
Namespace - Namespace of the Doc DB
See the Get() method for a description of the Properties parameter.
If a specific property is not passed in the properties array, the value is not modified.

Queries

• query List(Names As %String, Namespaces As %String, Filter As %String)
Selects Name As %String, Namespace As %String, Enabled As %String, Resource As %String, Description As %String
Return list of Doc DBs.
Names - Comma separated list of Doc DB names, "*" = All
Namespaces - Comma separated list of Namespaces, "*" = All
Note: This query may change in future versions

Indices

•index (SourceTypeNameLowerCaseIndex on NameLowerCase,NamespaceLowerCase) [IdKey,Unique];


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