Config.MapShards

hidden persistent class Config.MapShards extends %Library.Persistent, Config.CommonMapMethods, Config.CommonMapProperties, %SYSTEM.Help

SQL Table Name: Config.MapShards

This class allows you to modify and view shard mappings in the [Map.xxx] 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 a shard mapping in namespace USER to the USERDATA namespace on Node Machine1
%SYS>s Namespace="USER"
%SYS>s Name="Shard1"
%SYS>s Properties("ShardName")="SHARD1"
%SYS>s Properties("MapNamespace")="USERDATA"
%SYS>s Status=##Class(Config.MapShards).Create(Namespace,Name,.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now delete the object we just created
%SYS>s Status=##Class(Config.MapShards).Delete(Namespace,Name)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)

Property Inventory

• MapNamespace
• ShardName

Method Inventory

• %OnDeleteCallBack()

Properties

property MapNamespace as %String (MAXLEN = 64, MINLEN = 1) [ Required ];

Namespace to map global to.

Property methods: MapNamespaceDisplayToLogical(), MapNamespaceGet(), MapNamespaceGetStored(), MapNamespaceIsValid(), MapNamespaceLogicalToDisplay(), MapNamespaceLogicalToOdbc(), MapNamespaceNormalize()

property ShardName as %String (MAXLEN = 256) [ Required ];

Shard name to connect to.

Property methods: ShardNameDisplayToLogical(), ShardNameGet(), ShardNameGetStored(), ShardNameIsValid(), ShardNameLogicalToDisplay(), ShardNameLogicalToOdbc(), ShardNameNormalize()

Methods

classmethod %OnDeleteCallBack(Obj As %ObjectHandle) as %Status

Called from %Delete().
Any error returned here will keep the object from being deleted.

Queries

query List(Namespace As %String, Names As %String = "*", CPFFile As %String = "", Flags As %Integer = 0)

Selects Name As %String, ShardName, MapNamespace As %String

List MapShards in a CPF file.

Parameters:
Names - Comma separated list of MapShard names
"*" - All records match
"String,String1" - Any records matching one of these elements
"String*" - Any record starting with "String"
"String,String1*,String2" - Any record mathing 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

Indexes

index (CPFNameSectionHeaderNspName on CPFName,SectionHeader,Namespace,Name) [IdKey, Type = key, Unique];

Index methods: CPFNameSectionHeaderNspNameCheck(), CPFNameSectionHeaderNspNameDelete(), CPFNameSectionHeaderNspNameExists(), CPFNameSectionHeaderNspNameOpen(), CPFNameSectionHeaderNspNameSQLCheckUnique(), CPFNameSectionHeaderNspNameSQLExists(), CPFNameSectionHeaderNspNameSQLFindPKeyByConstraint(), CPFNameSectionHeaderNspNameSQLFindRowIDByConstraint()

Inherited Members

Inherited Properties

• CPFFile
• Comments
• Flags
• Name
• Namespace

Inherited 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()
• Create()
• Delete()
• Exists()
• Get()
• GetList()
• Help()
• Modify()
• Open()
• XMLDTD()
• XMLExport()
• XMLExportToStream()
• XMLExportToString()
• XMLNew()
• XMLSchema()
• XMLSchemaNamespace()
• XMLSchemaType()

Storage

Storage Model: CacheStorage (Config.MapShards)

^|"^^"_$ZU(12)|SYS("CONFIG")(ID)

=

%%CLASSNAME ShardName MapNamespace Comments