Class: Iris

"intersystems-iris-native".Iris

Source:

Methods

classMethodValue(methodName, …argument) → {any}

Call a method in a class that returns a value.
Parameters:
Name Type Attributes Description
methodName string the name of the method to call
argument any <repeatable>
arguments to pass to the method, zero one or more.
Source:
Throws:
exception
Returns:
- the class method's return value
Type
any

classMethodVoid(methodName, …argument)

Call a method in a class without returning a value.
Parameters:
Name Type Attributes Description
methodName string the name of the method to call
argument any <repeatable>
arguments to pass to the method, zero one or more.
Source:

function(routineName, functionName, …argument) → {any}

Invoke a function in a routine.
Parameters:
Name Type Attributes Description
routineName string the name of the routine in which the function is implemented
functionName string the name of the function to invoke
argument any <repeatable>
zero, one or more arguments to pass to the function
Source:
Returns:
- the function's return value
Type
any

get(globalName, …subscript) → {any}

Get the value of a global array node, returns null if the node is not defined.
Parameters:
Name Type Attributes Description
globalName string the name of the global array
subscript string <repeatable>
variable number of subscript values
Source:
Throws:
exception
Returns:
Type
any

getAPIVersion() → {string}

Get the API version string as major.minor.patch
Source:
Throws:
exception
Returns:
Type
string

getBoolean(globalName, …subscript) → {boolean}

Get the boolean value of a global array node, returns null if the node is not defined.
Parameters:
Name Type Attributes Description
globalName string the name of the global array
subscript string <repeatable>
variable number of subscript values
Source:
Throws:
exception
Returns:
Type
boolean

getBytes(globalName, …subscript) → {ArrayBuffer}

Get the value of a global array node as an ArrayBuffer, returns null if the node is not defined.
Parameters:
Name Type Attributes Description
globalName string the name of the global array
subscript string <repeatable>
variable number of subscript values
Source:
Throws:
exception
Returns:
Type
ArrayBuffer

getNumber(globalName, …subscript) → {number}

Get the numeric value of a global array node, returns null if the node is not defined.
Parameters:
Name Type Attributes Description
globalName string the name of the global array
subscript string <repeatable>
variable number of subscript values
Source:
Throws:
exception
Returns:
Type
number

getServerVersion() → {string}

Get the IRIS Server's version string.
Source:
Throws:
exception
Returns:
Type
string

getString(globalName, …subscript) → {string}

Get the value of a global array node as a string, returns null if the node is not defined.
Parameters:
Name Type Attributes Description
globalName string the name of the global array
subscript string <repeatable>
variable number of subscript values
Source:
Throws:
exception
Returns:
Type
string

getTLevel() → {number}

Get the nesting level of the current server transaction.
Source:
Returns:
- the nesting level of the current server transaction, 0 if no transaction is active
Type
number

increment(incrementBy, globalName, …subscript) → {number}

Increment the value of a global array node.
Parameters:
Name Type Attributes Description
incrementBy number the amount to increment the global array node by
globalName string the name of the global array
subscript string <repeatable>
variable number of subscript values
Source:
Returns:
Type
number

isDefined(globalName, …subscript) → {number}

Check to see if a global array node is defined.
Parameters:
Name Type Attributes Description
globalName string the name of the global array
subscript string <repeatable>
variable number of subscript values
Source:
Returns:
- 0 if the global array node is not defined, 1 if it is defined and has no subordinate nodes, 10 if not defined but has subordinate nodes, 11 if defined and has subordinate nodes.
Type
number

iterator(globalName, …subscript) → {external:"intersystems-iris-native".Iterator}

Instantiate the Iterator class.
Parameters:
Name Type Attributes Description
globalName string the name of the global array
subscript string <repeatable>
variable number of subscript values
Source:
Throws:
exception
Returns:
Type
external:"intersystems-iris-native".Iterator

kill(globalName, …subscript)

Kill a global array node.
Parameters:
Name Type Attributes Description
globalName string the name of the global array
subscript string <repeatable>
variable number of subscript values
Source:

lock(lockType, timeout, lockReference, …subscript) → {boolean}

Lock a global array. The lockMode argument specifies whether any previously held locks should be released. This method will time out after a predefined interval if the lock cannot be acquired. NOTE: The lockReference value must begin with '^' to acquire a lock on a global node.
Parameters:
Name Type Attributes Description
lockType string 'S' for shared lock and 'E' for an escalating lock
timeout integer the number of seconds before the attempt to acquire the lock will timeout
lockReference string a leading '^' is required for global array references. Note that lock() and unlock() are different from all other functions. where only a globalName - without the '^' prefix - is required.
subscript string <repeatable>
Source:
Returns:
Type
boolean

procedure(routineName, procedureName, …argument)

Invoke a procedure (no value is returned) in a routine.
Parameters:
Name Type Attributes Description
routineName string the name of the routine in which the procedure is implemented
procedureName string the name of the procedure to invoke
argument any <repeatable>
zero, one or more arguments to pass to the procedure
Source:

releaseAllLocks()

Release all global array locks held by the connection.
Source:

set(value, globalName, …subscript)

Set the value of a global array node.
Parameters:
Name Type Attributes Description
value string | number | true | false | NULL the value to assign to the global array
globalName string the name of the global array
subscript string <repeatable>
variable number of subscript values
Source:
Throws:
exception

tCommit()

Commit one level of a server transaction.
Source:

tRollback()

Rollback all levels of the server transaction.
Source:

tRollbackOne()

Rollback one level of the server transaction.
Source:

tStart()

Start a new server transaction.
Source:

unlock(lockMode, lockReference, …subscript)

Rrelease a previously acquired lock on *lockReference.
Parameters:
Name Type Attributes Description
lockMode string a string containing lock type ('S' or 'E') and 'I' for an immediate unlock or 'D' for deferred
lockReference string a leading '^' is required for global array references. Note that lock() and unlock() are different from all other functions. where only a globalName - without the '^' prefix - is required.
subscript string <repeatable>
Source:

© 2020 InterSystems Corporation, Cambridge, MA. All rights reserved.    Privacy & Terms Guarantee Section 508