|
%SYS
|
|
|
%SYS
|
|
This class allows you to modify and view the [Archives] section of the CPF file through programatic APIs. More...
Public Member Functions | |
| _.Library.Status | OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount) |
| Called from Save(). More... | |
| _.Library.Status | OnOpen () |
| This callback method is invoked by the <METHOD>Open</METHOD> method to. More... | |
Public Attributes | |
| Location | |
More... | |
| Type | |
More... | |
 Public Attributes inherited from CommonProperties | |
| CPFFile | |
| CPF file which the object maps to. More... | |
| Comments | |
| Embedded comments in the CPF file. More... | |
| Flags | |
| Flags governing how the object is processed when Save() is called. More... | |
| Name | |
| Name of the object instance. More... | |
Static Public Attributes | |
| CAPITALNAME = None | |
| Archive name is always capitalized. More... | |
| Static Public Attributes inherited from CommonMultipleMethods | |
| CAPITALNAME = None | |
| Determines if the Name specified in the index should be capitalized. More... | |
| SECTIONTYPE = None | |
| This parameter governs how the class creates audit records. More... | |
| Static Public Attributes inherited from CommonProperties | |
| DOMAIN = None | |
| This class contains properties which are included by classes which manipulate sections in the CPF file. More... | |
This class allows you to modify and view the [Archives] section of the CPF file through programatic APIs.
While properties are usually modified through the System Management portal, there may be some occasion where modifying them through the API's is best for your system. In all the Config methods, if you do not specify the CPFFile parameter, the currently active CPF file is used. If you wish to modify a CPF file which is not the currently active one, then specify the CPFFile you wish to modify in the method call.
The Flags parameter does not normally need to be specified; the defaults are usually sufficient for most cases.
You can use either the provided API's (Create/Get/Modify/Delete) to modify the properties by passing in the correct parameters, or use Object sytax to open and directly manipulate the config objects (Open() and Exists()). Most objects created here need only to specify the Name of the object, and 1 or 2 properties since the the defaults are what are commonly used for most cases.
EXAMPLE:
; Use class methods to create an instance
SYS>s Name="ABC"
SYS>s Properties("Type")="s3"
SYS>s Properties("Location")="s3://myBucket/"
SYS>s Status=##Class(Config.Archives).Create(Name,.Properties)
SYS>i '$$$ISOK(Status) w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Use class methods to modify properties
SYS>s Status=##Class(Config.Archives).Get(Name,.Properties)
SYS>i '$$$ISOK(Status) w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
SYS>zw Properties
Properties("Type")="s3"
Properties("Location")="s3://myBucket/"
SYS>s Properties("Location")="s3://myBucket2/"
SYS>s Status=##Class(Config.Archives).Modify(Name,.Properties)
SYS>i '$$$ISOK(Status) w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now use Objects to modify properties
SYS>s Obj=##Class(Config.Archives).Open(Name)
; We could have used i ##Class(Config.Archives).Exists(Name,.Obj) instead of Open()
SYS>w Obj.Type
s3
SYS>s Obj.Location="s3://myBucket/"
SYS>s Status=Obj.Save()
SYS>i '$$$ISOK(Status) w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now delete the object we just created
SYS>s Status=##Class(Config.Archives).Delete(Name)
SYS>i '$$$ISOK(Status) w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
| _.Library.Status OnAddToSaveSet | ( | _.Library.Integer | depth, |
| _.Library.Integer | insert, | ||
| _.Library.Integer | callcount | ||
| ) |
Called from Save().
Validate the archive info here, and possibly change it.
| _.Library.Status OnOpen | ( | ) |
This callback method is invoked by the <METHOD>Open</METHOD> method to.
provide notification that the object specified by oid is being opened.
If this method returns an error then the object will not be opened.
|
static |
Return Type,Location of a named archive target.
|
static |
Modify Dataset section instance in CPF file.
If the Server or Directory path is changed, it will be reflected on all Namespaces referring this DB.
Parameters:
Name - Name of the archive target to modify.
Properties (byref) - List of the properties to modify in Properties(Name)=Value format. See the subclass for a list of valid properties. If a specific property is not passed in the properties array, the value is not modified.
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file.
Flags - Bit string of options to perform. See the <METHOD>Create</METHOD> method for values.
Return values:
CPFFile (byref) - Name of the CPF file the modification was made in.
Reimplemented from CommonMultipleMethods.
|
static |
Rename the archive name in the CPF file.
Parameters:
OldName - Name of the archive to rename.
NewName (byref) - New name of the archive.
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file.
Return values:
CPFFile (byref) - Name of the CPF file the modification was made in.
|
static |
Archive name is always capitalized.
| Location |
| Type |
1.9.1