IRISLIB database
All Classes Namespaces Functions Variables Pages
Database Class Reference

This is a "Database" activity within a Manifest document. More...

Inheritance diagram for Database:
Collaboration diagram for Database:

Public Attributes

 BlockSize
 Database block size. More...
 
 ClusterMountMode
 Specifies whether the database should be mounted privately or clustered. More...
 
 Collation
 Database collation. More...
 
 Create
 Database creation flags:
More...
 
 Dir
 Database location on the filesystem. More...
 
 Encrypted
 Enable encryption for this database. More...
 
 EncryptionKeyID
 The encryption key id for an encrypted database. More...
 
 ExpansionSize
 Expansion size (i.e. More...
 
 InitialSize
 Initial database size (in MB) More...
 
 MaximumSize
 Maximum database size (in MB) More...
 
 MountAtStartup
 Specifies whether the database should be mounted at startup. More...
 
 MountRequired
 Specifies that the database MUST be successfully mounted at startup. More...
 
 PublicPermissions
 Public Permissions, zero or more of "R", "W", "U". More...
 
 Resource
 Database Resource required to access this database, for example DB_DEFAULT. More...
 
 StreamLocation
 Directory where the streams associated with this database go. More...
 
 Target
 Database "logical" name, for example USER or ENSDEMO. More...
 
- Public Attributes inherited from AbstractElement
 name
 This is the logical name of this node. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Public Member Functions inherited from Adaptor
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
 Serialize an XML enabled class as an XML document and write. More...
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and appends it to a stream. More...
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and write it to a string. More...
 
- Static Public Member Functions inherited from Adaptor
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Write the DTD to the current device for this XML enabled class serialized as. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
 
_.Library.String XMLSchemaNamespace ()
 Get the namespace to which this class belongs for use in schema generation. More...
 
_.Library.Status XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
 Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...
 
- Static Public Attributes inherited from Activity
 NAMESPACE = None
 This is the base class for activities within the document.
 
- Static Public Attributes inherited from AbstractElement
 XGENDOCUMENT = None
 This is the name of the XGEN document class that this node belongs to. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 By setting this to 0, we disallow use of invalid attribute names.
 
 XMLIGNORENULL = None
 By setting this 1, we ignore the difference between null and empty nodes within XGEN.
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 
- Static Public Attributes inherited from Adaptor
 ATTRIBUTEQUALIFIED = None
 ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
 
 ELEMENTQUALIFIED = None
 ELEMENTQUALIFIED controls the format of exported XML. More...
 
 NAMESPACE = None
 NAMESPACE specifies the XML namespace to be used when projecting the. More...
 
 SUPPRESSTYPEPREFIX = None
 SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
 
 XMLDEFAULTREFERENCE = None
 XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
 
 XMLENABLED = None
 If this parameter is true then XML-enabling methods. More...
 
 XMLFORMAT = None
 The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNOREINVALIDTAG = None
 The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNORENULL = None
 XMLIGNORENULL allows the programmer to override the default XML handling. More...
 
 XMLINCLUDEINGROUP = None
 XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
 
 XMLINHERITANCE = None
 If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
 
 XMLNAME = None
 This parameter provides the default XMLNAME for the class. More...
 
 XMLNIL = None
 The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
 
 XMLNILNOOBJECT = None
 The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
 
 XMLPREFIX = None
 The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
 
 XMLSEQUENCE = None
 If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
 
 XMLSUMMARY = None
 The summary fields to be used when an object is referenced are specified. More...
 
 XMLTYPE = None
 This parameter provides the default XMLTYPE for the class. More...
 
 XMLUNSWIZZLE = None
 If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
 
 XMLUSEEMPTYELEMENT = None
 If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...
 

Detailed Description

This is a "Database" activity within a Manifest document.

Member Data Documentation

◆ BlockSize

BlockSize

Database block size.

 

◆ ClusterMountMode

ClusterMountMode

Specifies whether the database should be mounted privately or clustered.


0 - Mount private
1 - Mount clustered
 

◆ Collation

Collation

Database collation.

 

◆ Create

Create

Database creation flags:

yes - Must always create the database, will fail if already exists
no - Database must already exist
overwrite - Overwrite if present, or create a new one.  

◆ Dir

Dir

Database location on the filesystem.

 

◆ Encrypted

Encrypted

Enable encryption for this database.

 

◆ EncryptionKeyID

EncryptionKeyID

The encryption key id for an encrypted database.

 

◆ ExpansionSize

ExpansionSize

Expansion size (i.e.

by how many MB should the DB get expanded when it fills)

 

◆ InitialSize

InitialSize

Initial database size (in MB)

 

◆ MaximumSize

MaximumSize

Maximum database size (in MB)

 

◆ MountAtStartup

MountAtStartup

Specifies whether the database should be mounted at startup.


0 - Don't mount at startup
1 - Mount at startup
 

◆ MountRequired

MountRequired

Specifies that the database MUST be successfully mounted at startup.


0 - Successful mount not required for startup to succeed.
1 - Successful mount required for startup to succeed.
 

◆ PublicPermissions

PublicPermissions

Public Permissions, zero or more of "R", "W", "U".

 

◆ Resource

Database Resource required to access this database, for example DB_DEFAULT.

 

◆ StreamLocation

StreamLocation

Directory where the streams associated with this database go.


By default (value=""), the location is in the subdirectory "stream", underneath the database directory, e.g. for a database located in c:\abc, the default would be c:\abc\stream. InterSystems recommends leaving this parameter as "".
 

◆ Target

Target

Database "logical" name, for example USER or ENSDEMO.