Skip to main content

Config.SqlSysDatatypes

Class Config.SqlSysDatatypes Extends (%Persistent, Config.CommonMultipleMethods, Config.CommonProperties, %SYSTEM.Help) [ Final, Inheritance = right, System = 4 ]

This class allows you to modify and view the [SqlSysDatatypes] 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 syntax 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:

%SYS>s Name="BIGINT" %SYS>s Status=##Class(Config.SqlSysDatatypes).Get(Name,.Properties) %SYS>i '$Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status) %SYS>zw Properties Properties("Datatype")="%Library.BigInt"

Properties​

Datatype​

Property Datatype As %String(MAXLEN = 256, MINLEN = 1) [ Required ];

Methods​

CreateCallBack​

ClassMethod CreateCallBack(Obj As %ObjectHandle, Data As %String) As %Status [ Internal ]

Called by the Create method during import from a CPF file.

Default​

ClassMethod Default(CPFFile As %String, Platform As %String) As %Status [ Internal ]

Write a default SqlSysDatatypes section in a CPF file.

Load​

ClassMethod Load(Obj As %ObjectHandle = "", Flags As %Integer = 1) As %Status [ Internal ]

Load the parameters into memory and activate.
Parameters:
Obj = Handle to the object which caused the load. If "", then load everything, only called from STU.
If a delete operation, then Obj is the NAME of the item which was deleted since the oject itself has already been deleted.
Flags = Type of modification.
0 - Modify
1 - Create/Insert
2 - Delete

ListExecute​

ClassMethod ListExecute(ByRef %qHandle As %Binary, Names As %String = "*", CPFFile As %String = "", Flags As %Integer = 0, Format As %Integer = 0) As %Status [ Internal ]

List SqlSysDatatypes in a CPF file.

Parameters:
Names - Comma separated list of SqlSysDatatype names
"*" - All records match
"String,String1" - Any records matching one of these elements
"String*" - Any record starting with "String"
"String,String1*,String2" - Any record matching one of these elements, or starting with "String1"
CPFFile - Name of the CPF file to use. A null string means use the active CPF file.
Flags - Currently ignored.
Format
0 - Standard report list format
1 - ^CONFIG global format
2 - CPF file format format
Note: This query may change in future versions

ListFetch​

ClassMethod ListFetch(ByRef %qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = ListExecute ]

ListClose​

ClassMethod ListClose(ByRef %qHandle As %Binary) As %Status [ Internal, PlaceAfter = ListExecute ]