Config.config
persistent class Config.config extends %Library.Persistent, Config.CommonSingleMethods, Config.CommonProperties, %SYSTEM.Help [ Final ]
SQL Table Name: Config.config
This class allows you to modify and view the [config] 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 (Get/Modify) to modify the properties by passing in the correct parameters, or use Object syntax to open and directly manipulate the config objects.
EXAMPLE:
; Use class methods to modify properties %SYS>s Status=##Class(Config.config).Get(.Properties) %SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status) %SYS>zw Properties("MaxServers") Properties("MaxServers")=2 %SYS>s Properties("MaxServers")=3 %SYS>s Status=##Class(Config.config).Modify(.Properties) %SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status) ; Now use Objects to modify properties %SYS>s Obj=##Class(Config.config).Open() %SYS>w Obj.MaxServers 3 %SYS>s Obj.MaxServers=4 %SYS>s Status=Obj.%Save() %SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
Property Inventory
- BackoffDisabled
- ConsoleFile
- LargePagesDisabled
- LargePagesRequired
- LibPath
- LockSharedMemory
- LockTextSegment
- MaxServerConn
- MaxServers
- PythonPath
- PythonRuntimeLibrary
- PythonRuntimeLibraryVersion
- UUIDv1RandomMac
- VMSConsoleTerminal
- ZFSize
- ZFString
- bbsiz
- console
- errlog
- globals
- globals16kb
- globals32kb
- globals4kb
- globals64kb
- globals8kb
- gmheap
- history
- ijcbuff
- ijcnum
- jrnbufs
- locksiz
- memlock
- netjob
- nlstab
- overview
- pijdir
- routines
- targwijsz
- udevtabsiz
- useresidentmem
- wijdir
Method Inventory
Parameters
They have a corresponding %Boolean property to determine if they are in the file or not. For example, the property "Asyncwij" will have a %Boolean "AsyncwijPresent" property associated with it.
These properties are for InterSystems use only.
These are properties which are combined with other properties to create a property in the CPF file.
Properties
Makes up part of the CPF parameter memlock=
Modifying this property will require a restart of the system to make it active.
Null means the MGR directory.
This is the second piece of the CPF parameter console=VMSConsoleTerminal,ConsoleFile
Modifying this property does not require a restart of the system to make it active.
Makes up part of the CPF parameter memlock=
Modifying this property will require a restart of the system to make it active.
Makes up part of the CPF parameter memlock=
Modifying this property will require a restart of the system to make it active.
Modifying this property does not require a restart of the system to make it active.
Makes up part of the CPF parameter memlock=.
Modifying this property will require a restart of the system to make it active.
Makes up part of the CPF parameter memlock=
Modifying this property will require a restart of the system to make it active.
Modifying this property will require a restart of the system to make it active.
Modifying this property does not require a restart of the system to make it active if memory is available in the shared memory heap.
Also see iris_site.py (in the instance directory) and Embedded Python documentation for other ways to affect sys.path.
Modifying this property does not require a restart of the system to make it active.
default Embedded Python that Intersystems tests with.
Example on Ubuntu 22:
"/lib/x86_64-linux-gnu/libpython3.11.so.1.0"
Example on windows:
"C:\Program Files\Python39\python3.dll"
"C:\Program Files\Python311\python3.dll"
Use a string(quotes) when setting it in object script. It appears in the iris.cpf file without quotes surrounding it.
Modifying this property does not require a restart of the system to make it active.
Used in properly loading PythonRuntimeLibrary into IRIS.
Use a string(quotes) when setting it in object script: set properties("PythonRuntimeLibraryVersion")="3.11"
It appears in the iris.cpf file without quotes surrounding the 3.11
Modifying this property does not require a restart of the system to make it active.
as described in RFC4122 section 4.5. Please read the CreateGUID documentation for why you would want to do this.
1 means use random mac
0 means use existing mac - (the system will autodetect one of your ethernet ports or make up a combined non mac value to use if detection doesnt work)
This is the first piece of the CPF parameter console=VMSConsoleTerminal,ConsoleFile
Modifying this property does not require a restart of the system to make it active.
This is the second piece of the CPF parameter zfheap=ZFString,ZFSize
Modifying this property does not require a restart of the system to make it active.
This is the First piece of the CPF parameter zfheap=ZFString,ZFSize
Modifying this property does not require a restart of the system to make it active.
-1 means "unlimited" (limited only by the implementation maximum of ~2TB).
Modifying this property does not require a restart of the system to make it active.
The log file will expire old entries when this limit is reached.
Modifying this property will require a restart of the system to make it active.
Element #1 corresponds to 2KB blocks (deprecated, always 0 now).
Element #2 corresponds to 4KB blocks.
Element #3 corresponds to 8KB blocks.
Element #4 corresponds to 16KB blocks.
Element #5 corresponds to 32KB blocks.
Element #6 corresponds to 64KB blocks.
If all values are zero, as they are by default, the system selects a value based on physical memory. This is designed so that newly installed system can perform reasonably well, and it is intended to be changed.
Modifying this property will require a restart of the system to make it active.
Modifying this property will require a restart of the system to make it active.
Modifying this property will require a restart of the system to make it active.
Modifying this property will require a restart of the system to make it active.
Modifying this property will require a restart of the system to make it active.
The shared memory heap is a pool of memory within the large shared memory segment allocated at startup. It is used by many subsystems that require dynamic shared memory reservations (from within this fixed-size heap), including the lock table, dejournaling, NLS tables, and more.
A value of 0 (the default) allows the system to choose a value based on the sizing info inferred from other parameters, and is designed to be sufficient for most systems. Small non-zero values are subject to internal lower limits.
Modifying this property requires a restart of the system to make it active.
Modifying this property does not require a restart of the system to make it active.
Modifying this property will require a restart of the system to make it active.
Modifying this property will require a restart of the system to make it active.
Modifying this property does not require a restart of the system to make it active.
CPF file representation of memlock=
Modifying this property does not require a restart of the system to make it active.
Modifying this property will require a restart of the system to make it active.
Modifying this property will require a restart of the system to make it active.
Modifying this property will require a restart of the system to make it active.
When the target size is larger than the size of the existing WIJ, the system will expand the WIJ while the write daemon is idle up to the specified target (but not to exceed the actual size of the WIJ needed to hold the entire buffer pool). The system can expand the WIJ past the target size if that becomes necessary to complete a write cycle.
Leaving this value set to 0 is fine. The system will grow the WIJ as needed based on activity. Generally the WIJ quickly reaches whatever size is needed to support the activity level/the size of the buffer pool. The purpose of setting a target size is that if space has been reserved for the WIJ, setting a target allows the WIJ to grow to occupy that space early on in the life of the system. Since user activity can be blocked if the WIJ is too small (the WIJ will try to expand if this happens), setting the target may lead to a better user experience after startup. If the target is set to 0, the WIJ may quickly expand as needed however users may be blocked at times when this happens until the WIJ reaches the size required by the system.
Modifying this property will require a restart of the system to make it active.
Modifying this property will require a restart of the system to make it active.
Modifying this property does not require an instance restart to activate the change except on cluster members.
Methods
This will always return a filename. If a %Status error is returned, the name of the file returned will be $zu(12)_messages.log. Note that this will return the messages.log file the system currently has open, not the one which is defined in the CPF file and not yet activated.
Parameters:
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. The file must have a .CPF file extension if specified.
Flags - Bit string of options to perform if the object is later saved with the %Save() method. See the Open() method for values.
Return values:
CPFFile (byref) - Name of the CPF file the modification was made in.
Indexes
Inherited Members
Inherited Properties
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %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()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- Get()
- GetList()
- Help()
- Open()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Storage Model: Storage (Config.config)
^|"^^"_$ZU(12)|SYS("CONFIG")(ID) |
= | Comments
Asyncwij
AsyncwijPresent
bbsiz
console
ConsoleFile
Edstrategy
EdstrategyPresent
errlog
globals
globals2kb
globals4kb
globals8kb
globals16kb
globals32kb
globals64kb
gmheap
history
ijcbuff
ijcnum
LibPath
LineRecallBuffer
LineRecallEntries
LockSharedMemory
LockTextSegment
locksiz
maxglorecord
maxglorecordPresent
Maxprocesses
MaxprocessesPresent
MaxServerConn
MaxServers
memlock
netjob
nlstab
OsType
overview
pijdir
Platform
routines
SecureKernel
synctype
synctypePresent
udevtabsiz
usedirectio
usedirectioPresent
useresidentmem
useresidentmemPresent
VMSConsoleTerminal
wdparm
wdparmPresent
wdstrategy
wdstrategyPresent
wduseasyncio
wduseasyncioPresent
wijdir
ZFSize
ZFString
zfheap
Path
jrnbufs
targwijsz
LargePagesDisabled
LargePagesRequired
BackoffDisabled
PageSizeAlt
SecureKernelPresent
PythonPath
PythonRuntimeLibrary
UUIDv1RandomMac
PythonRuntimeLibraryVersion
|