Skip to main content

%SYSTEM.Context.SQL

Class %SYSTEM.Context.SQL Extends %SystemBase

Properties​

CQLockTimeout​

Property CQLockTimeout As %Integer;

Cached Query Lock Timeout

externalGateways​

Property externalGateways As %SQL.External.Gateway [ MultiDimensional ];

ShardIDRange​

Property ShardIDRange As %RawString [ MultiDimensional ];

ShardIDRange is an array of extent names used for allocating rowid values for Sharded=2 tables. data is $lb(beginrange,endrange,offset)

ShardAIRange​

Property ShardAIRange As %RawString [ MultiDimensional ];

ShardAIRange is an array of extent names used for allocating auto_increment field values for Sharded=2 tables. data is $lb(beginrange,endrange,offset)

RTC​

Property RTC As %RawString [ MultiDimensional ];

RTC is an array of trigger names used for statement level recursive trigger call checking.
RTC = recursive trigger check

TSQLAnsiNulls​

Property TSQLAnsiNulls As %Integer;

TSQLAnsiPadding​

Property TSQLAnsiPadding As %Integer;

TSQLAnsiWarnings​

Property TSQLAnsiWarnings As %Integer;

TSQLCaseInsCompare​

Property TSQLCaseInsCompare As %Integer;

TSQLNoCount​

Property TSQLNoCount As %Integer;

TSQLQuotedIdentifier​

Property TSQLQuotedIdentifier As %Integer;

contextStack​

Property contextStack As %String(MAXLEN = "") [ MultiDimensional ];

Stats​

Property Stats As %String [ MultiDimensional ];

FTKeys​

Property FTKeys As %String [ MultiDimensional ];

Feature Tracker Keys for features tracked under the SQL/IntegratedML/xDBC umbrella

PredictModelOref​

Property PredictModelOref As %RawString [ MultiDimensional ];

PredictModelOref holds an oref for the ML Model for each PREDICT function in the statement

PredictTrainedModelOref​

Property PredictTrainedModelOref As %RawString [ MultiDimensional ];

PredictTrainedModelOref holds an oref for the ML TrainedModel for each PREDICT function in the statement

ShardExecIUDArgs​

Property ShardExecIUDArgs As %String [ MultiDimensional ];

ShardExecIUDArgs is used to hold the arguments for the %BigData.ShardedSQL.%ExecIUD method when the SQL Statement has more than 379 parameters.

ShardMasterExtRef​

Property ShardMasterExtRef As %RawString [ MultiDimensional ];

ShardMasterExtRef is used to hold the extended reference for the constraint lock syntax to use for this namespace. Since subscript is the namespace name.

ShardNumber​

Property ShardNumber As %RawString [ MultiDimensional ];

ShardNumber is used to hold the shard number of the current namespace if this is a sharded namespace Subscript is the namespace name.

DisableStatCollection​

Property DisableStatCollection As %Boolean [ InitialExpression = 0 ];

This can be set to true to disable time based collection of SQL stats

MLConfiguration​

Property MLConfiguration As %String(MAXLEN = 256);

This is the default %SYS.ML.Configuration for this process

Version​

Property Version As %Integer;

A version counter used to ensure that this object is loaded/instantiated with the most recent property values.

Methods​

DisableStatCollectionSet​

Method DisableStatCollectionSet(val As %Boolean) As %Status

pushState​

Method pushState() As %Status

pushState will push the current state of the Context.SQL singleton onto the contextStack. This method is not normally invoked directly. It is normally called by a utility class method to push a context.

popState​

Method popState() As %Status

popState will restore the state of the Context.SQL singleton from the top of the contextStack and remove the top stack element. This method is not normally invoked directly. It is normally called by a utility class method to pop a context.

%OnNew​

Method %OnNew() As %Status [ Private, ServerOnly = 1 ]

%OnClose​

Method %OnClose() As %Status [ Private ]

ClearStats​

Method ClearStats() As %Status

Remove any SQL stats we have aggregated so far

SaveStats​

Method SaveStats() As %Status

Store any SQL stats we have collected so far. Normally done automatically at regular time intervals but can be forced by calling this method.

getGateway​

Method getGateway(gatewayName As %String, language As %String) As %RawString

language is only used if the gateway is not already defined

getCachedGateway​

Method getCachedGateway(serverName As %String) As %RawString

Return a cached gateway connection, null if nothing is cached