Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%SYS] >  [GlobalQuery]
Private  Storage   

abstract class %SYS.GlobalQuery extends %SYSTEM.Help

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 5


Summary

Methods
Help


Parameters

• parameter DOMAIN = "%Utility";
Default Localization Domain

Queries

• query DirectoryList(Directory As %String, System As %String, Mask As %String, SystemGlobals As %Boolean, Index As %Integer, IgnoreHasData As %Boolean = 0)
Selects Name As %String, ResourceName As %String, Permission As %String, Empty As %String, Keep As %String, Collation As %String, PointerBlock As %String, GrowthBlock As %String, HasData As %Boolean, Journal As %String
Returns a list of the Globals in a database

Parameters:
Directory - the directory file-spec for a database file.
System - ECP database server logical name, as defined in the Application Server list.
Mask - a mask, or comma-separated list of masks, to select globals. Default is "*" for all.
SystemGlobals - boolean flag to include system globals in the results. Default is "0".
Index - Internal use only.
IgnoreHasData - For faster list of Globals set this to 1 and the HasData column will always be FALSE.

Valid masks are as follows:
ABC* - All strings starting with ABC
A:D - All strings between A and D
A:D,Y* - All strings between A and D, and all strings starting with Y
A:D,'C* - All strings between A and D, except those starting with C
• query MoveGlobalsList(NameSpace As %String, Mask As %String, SystemGlobals As %Boolean, ByRef UnavailableDatabases As %String, Index2 As %Integer, IgnoreHasData As %Boolean = 0)
Selects Name As %String, Database As %String, Directory As %String, HasSubscripts As %Boolean, Info As %String, Status As %Integer, MoveName As %String, Abort As %Integer, State As %Integer, StopQ As %Boolean, RestartQ As %Boolean, DeleteQ As %Boolean, RollbackQ As %Boolean, LogQ As %Boolean
Returns a list of the Globals in a namespace (used for GUI display)

Parameters:
NameSpace - a namespace. Default is current namespace.
Mask - a mask, or comma-separated list of masks, to select globals. Default is "*" for all.
SystemGlobals - boolean flag to include system globals in the results. Default is "0".
UnavailableDatabases - a returned local array of any databases not currently accessible, i.e. array(name)=status.
Index - Internal use only.
IgnoreHasData - For faster list of Globals set this to 1 and the HasData column will always be FALSE.

Valid masks are as follows:
ABC* - All strings starting with ABC
A:D - All strings between A and D
A:D,Y* - All strings between A and D, and all strings starting with Y
A:D,'C* - All strings between A and D, except those starting with C
• query NameSpaceList(NameSpace As %String, Mask As %String, SystemGlobals As %Boolean, ByRef UnavailableDatabases As %String, Index As %Integer, IgnoreHasData As %Boolean = 0, Mapped As %Boolean = 1)
Selects Name As %String, Location As %String, ResourceName As %String, Permission As %String, Empty As %String, Keep As %String, Collation As %String, PointerBlock As %String, GrowthBlock As %String, HasData As %Boolean, Journal As %String, LockLocation As %String, HasSubscripts As %Boolean
Returns a list of the Globals in a namespace (used for GUI display)

Parameters:
NameSpace - a namespace. Default is current namespace.
Mask - a mask, or comma-separated list of masks, to select globals. Default is "*" for all.
SystemGlobals - boolean flag to include system globals in the results. Default is "0".
UnavailableDatabases - a returned local array of any databases not currently accessible, i.e. array(name)=status.
Index - Internal use only.
IgnoreHasData - For faster list of Globals set this to 1 and the HasData column will always be FALSE.
Mapped - Return all mapped global nodes when set to 1, the default value of this parameter is 1.
Valid masks are as follows:
ABC* - All strings starting with ABC
A:D - All strings between A and D
A:D,Y* - All strings between A and D, and all strings starting with Y
A:D,'C* - All strings between A and D, except those starting with C
• query NameSpaceListChui(NameSpace As %String, Mask As %String, SystemGlobals As %Boolean, ByRef UnavailableDatabases As %String, Index As %Integer)
Selects Name As %String, Location As %String, ResourceName As %String, Permission As %String, Empty As %String, Keep As %String, Collation As %String, Ptr As %String, Grth As %String, HasData As %Boolean, Jrn As %String, LockLocation As %String
Returns a list of Globals in a namespace (used for terminal display)

Parameters:
NameSpace - a namespace. Default is current namespace.
Mask - a mask, or comma-separated list of masks, to select globals. Default is "*" for all.
SystemGlobals - boolean flag to include system globals in the results. Default is "0".
UnavailableDatabases - a returned local array of any databases not currently accessible, i.e. array(name)=status.
Index - Internal use only.

Valid masks are as follows:
ABC* - All strings starting with ABC
A:D - All strings between A and D
A:D,Y* - All strings between A and D, and all strings starting with Y
A:D,'C* - All strings between A and D, except those starting with C
• query Size(Directory As %String, System As %String = "", Mask As %String, SystemGlobals As %Boolean, Index As %Integer, FastFlag As %Boolean)
Selects Name As %String, Allocated MB As %Float, Used MB As %Float
Returns the size of Globals in a database

Parameters:
Directory - the directory file-spec for a database file.
System - Currently ignored, pass as a null string. Getting the size of a global in an ECP mounted database is not currently supported. You can get the size for these globals directly on the ECP server itself.
Mask - a mask, or comma-separated list of masks, to select globals. Default is "*" for all.
SystemGlobals - boolean flag to include system globals in the results. Default is "0".
Index - Internal use only.
FastFlag - Don't return 'Used' count, it would be zero. This is for faster operation.

Valid masks are as follows:
ABC* - All strings starting with ABC
A:D - All strings between A and D
A:D,Y* - All strings between A and D, and all strings starting with Y
A:D,'C* - All strings between A and D, except those starting with C


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.