Skip to main content

INFORMATION.SCHEMA.STATEMENTS

persistent class INFORMATION.SCHEMA.STATEMENTS extends %Library.Persistent, %XML.Adaptor

SQL Table Name: INFORMATION_SCHEMA.STATEMENTS

Contains SQL Statement Index entries that can be accessed by the current user in the current namespace.

Property Inventory

Method Inventory

Parameters

parameter READONLY = 1;
Inherited description: READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.

Properties

property CallStack as %List;
Call stack at the time the query was built
Property methods: CallStackGet(), CallStackIsValid(), CallStackLogicalToOdbc(), CallStackLogicalToXSD(), CallStackOdbcToLogical(), CallStackSet(), CallStackXSDToLogical()
relationship Children as array of INFORMATION.SCHEMA.STATEMENTCHILDREN [ InitialExpression = $listbuild("INFORMATION.SCHEMA.STATEMENTCHILDREN","Statement",+$this,"children",1,1) , Transient , Inverse = Statement , Cardinality = children ];
Property methods: ChildrenGet(), ChildrenGetObject(), ChildrenGetObjectId(), ChildrenGetSwizzled(), ChildrenIsEmpty(), ChildrenIsValid(), ChildrenNewObject(), ChildrenRClose(), ChildrenRExec(), ChildrenRFetch(), ChildrenRelate(), ChildrenSQLCompute(), ChildrenSet(), ChildrenUnRelate()
property ClientApp as %String;
Client application name at the time the query was built
Property methods: ClientAppDisplayToLogical(), ClientAppGet(), ClientAppIsValid(), ClientAppLogicalToDisplay(), ClientAppLogicalToOdbc(), ClientAppNormalize(), ClientAppSet()
property ClientIP as %String;
Client IP address at the time the query was built
Property methods: ClientIPDisplayToLogical(), ClientIPGet(), ClientIPIsValid(), ClientIPLogicalToDisplay(), ClientIPLogicalToOdbc(), ClientIPNormalize(), ClientIPSet()
property ClientName as %String;
Client name at the time the query was built
Property methods: ClientNameDisplayToLogical(), ClientNameGet(), ClientNameIsValid(), ClientNameLogicalToDisplay(), ClientNameLogicalToOdbc(), ClientNameNormalize(), ClientNameSet()
relationship Days as array of INFORMATION.SCHEMA.STATEMENTDAILYSTATS (XMLPROJECTION = "NONE") [ InitialExpression = $listbuild("INFORMATION.SCHEMA.STATEMENTDAILYSTATS","Statement",+$this,"children",1,1) , Transient , Inverse = Statement , Cardinality = children ];
Breakdown of light weight SQL stats per day
Property methods: DaysGet(), DaysGetObject(), DaysGetObjectId(), DaysGetSwizzled(), DaysIsEmpty(), DaysIsValid(), DaysNewObject(), DaysRClose(), DaysRExec(), DaysRFetch(), DaysRelate(), DaysSQLCompute(), DaysSet(), DaysUnRelate()
property DefaultSchema as %Library.List;
Value of %defschema when the statement was compiled
Property methods: DefaultSchemaGet(), DefaultSchemaIsValid(), DefaultSchemaLogicalToOdbc(), DefaultSchemaLogicalToXSD(), DefaultSchemaOdbcToLogical(), DefaultSchemaSet(), DefaultSchemaXSDToLogical()
property Error as %String (MAXLEN = 4096);
Error string recorded for this plan
Property methods: ErrorDisplayToLogical(), ErrorGet(), ErrorIsValid(), ErrorLogicalToDisplay(), ErrorLogicalToOdbc(), ErrorNormalize(), ErrorSet()
property Frozen as %Integer;
0/1/2/3 flag which defines if the statement plan Unfrozen (0), Frozen/Explicit (1), Frozen/Upgrade (2), or Unfrozen/Parallel (3)
Property methods: FrozenDisplayToLogical(), FrozenGet(), FrozenIsValid(), FrozenLogicalToDisplay(), FrozenNormalize(), FrozenSet(), FrozenXSDToLogical()
property FrozenDifferent as %Boolean;
True if the frozen plan is different to what we would use if the plan was not frozen
Property methods: FrozenDifferentDisplayToLogical(), FrozenDifferentGet(), FrozenDifferentIsValid(), FrozenDifferentLogicalToDisplay(), FrozenDifferentLogicalToXSD(), FrozenDifferentNormalize(), FrozenDifferentSet(), FrozenDifferentXSDToLogical()
property Hash as %String (MAXLEN = 32) [ Required ];
Internal unique statement hash used as the ID for the statement.
Property methods: HashDisplayToLogical(), HashGet(), HashIsValid(), HashLogicalToDisplay(), HashLogicalToOdbc(), HashNormalize(), HashSet()
property JSONPlan as %String (XMLPROJECTION = "NONE") [ Calculated ];
Machine Readable Query Plan
Property methods: JSONPlanCompute(), JSONPlanDisplayToLogical(), JSONPlanGet(), JSONPlanIsValid(), JSONPlanLogicalToDisplay(), JSONPlanLogicalToOdbc(), JSONPlanNormalize(), JSONPlanSQLCompute()
relationship Locations as array of INFORMATION.SCHEMA.STATEMENTLOCATIONS (XMLPROJECTION = "NONE") [ InitialExpression = $listbuild("INFORMATION.SCHEMA.STATEMENTLOCATIONS","Statement",+$this,"children",1,1) , Transient , Inverse = Statement , Cardinality = children ];
Property methods: LocationsGet(), LocationsGetObject(), LocationsGetObjectId(), LocationsGetSwizzled(), LocationsIsEmpty(), LocationsIsValid(), LocationsNewObject(), LocationsRClose(), LocationsRExec(), LocationsRFetch(), LocationsRelate(), LocationsSQLCompute(), LocationsSet(), LocationsUnRelate()
property NaturalQuery as %Boolean;
Set to true for 'natural' queries which are already maximally efficient and for which we do not collect any statistics as the overhead of statistical collection would have a significant impact on the statement performance.
Property methods: NaturalQueryDisplayToLogical(), NaturalQueryGet(), NaturalQueryIsValid(), NaturalQueryLogicalToDisplay(), NaturalQueryLogicalToXSD(), NaturalQueryNormalize(), NaturalQuerySet(), NaturalQueryXSDToLogical()
property Packages as %Library.List;
Value of packages argument passed to SQL compiler when the statement was compiled
Property methods: PackagesGet(), PackagesIsValid(), PackagesLogicalToOdbc(), PackagesLogicalToXSD(), PackagesOdbcToLogical(), PackagesSet(), PackagesXSDToLogical()
property ParentHash as %String (MAXLEN = 32);
Hash of this statement's parent statement. Only defined if this is a recursive compile for %PARALLEL statements. This references the root parent's hash.
Property methods: ParentHashDisplayToLogical(), ParentHashGet(), ParentHashIsValid(), ParentHashLogicalToDisplay(), ParentHashLogicalToOdbc(), ParentHashNormalize(), ParentHashSet()
property Plan as %String (XMLPROJECTION = "NONE") [ Calculated ];
Query plan
Property methods: PlanCompute(), PlanDisplayToLogical(), PlanGet(), PlanIsValid(), PlanLogicalToDisplay(), PlanLogicalToOdbc(), PlanNormalize(), PlanSQLCompute()
relationship PrivilegeRelations as array of INFORMATION.SCHEMA.STATEMENTPRIVOBJECTS [ InitialExpression = $listbuild("INFORMATION.SCHEMA.STATEMENTPRIVOBJECTS","Statements",+$this,"children",1,1) , Transient , Inverse = Statements , Cardinality = children ];
Property methods: PrivilegeRelationsGet(), PrivilegeRelationsGetObject(), PrivilegeRelationsGetObjectId(), PrivilegeRelationsGetSwizzled(), PrivilegeRelationsIsEmpty(), PrivilegeRelationsIsValid(), PrivilegeRelationsNewObject(), PrivilegeRelationsRClose(), PrivilegeRelationsRExec(), PrivilegeRelationsRFetch(), PrivilegeRelationsRelate(), PrivilegeRelationsSQLCompute(), PrivilegeRelationsSet(), PrivilegeRelationsUnRelate()
relationship Relations as array of INFORMATION.SCHEMA.STATEMENTRELATIONS [ InitialExpression = $listbuild("INFORMATION.SCHEMA.STATEMENTRELATIONS","Statement",+$this,"children",1,1) , Transient , Inverse = Statement , Cardinality = children ];
Property methods: RelationsGet(), RelationsGetObject(), RelationsGetObjectId(), RelationsGetSwizzled(), RelationsIsEmpty(), RelationsIsValid(), RelationsNewObject(), RelationsRClose(), RelationsRExec(), RelationsRFetch(), RelationsRelate(), RelationsSQLCompute(), RelationsSet(), RelationsUnRelate()
property SQLSchemaPath as %Library.List;
Value of %sqlSchemaPath when the statement was compiled
Property methods: SQLSchemaPathGet(), SQLSchemaPathIsValid(), SQLSchemaPathLogicalToOdbc(), SQLSchemaPathLogicalToXSD(), SQLSchemaPathOdbcToLogical(), SQLSchemaPathSet(), SQLSchemaPathXSDToLogical()
property SQLStatementID as %Integer;
A Unique SQL Statement Identifier which can be used to identify each SQL Statement that is stored in the SQL Statement Index (SSI)...
Property methods: SQLStatementIDDisplayToLogical(), SQLStatementIDGet(), SQLStatementIDIsValid(), SQLStatementIDLogicalToDisplay(), SQLStatementIDNormalize(), SQLStatementIDSet(), SQLStatementIDXSDToLogical()
property SqlComp as %String (MAXLEN = 32);
SQL Compilation mode, Logical, Odbc, Display, Runtime, etc., when the statement was compiled
Property methods: SqlCompDisplayToLogical(), SqlCompGet(), SqlCompIsValid(), SqlCompLogicalToDisplay(), SqlCompLogicalToOdbc(), SqlCompNormalize(), SqlCompSet()
property StatAverage as %Double [ Calculated ];
Average time spent running this query
Property methods: StatAverageCompute(), StatAverageDisplayToLogical(), StatAverageGet(), StatAverageIsValid(), StatAverageLogicalToDisplay(), StatAverageLogicalToXSD(), StatAverageNormalize(), StatAverageOdbcToLogical(), StatAverageSQLCompute(), StatAverageXSDToLogical()
property StatCommands as %Integer;
Total ObjectScript commands executed from running this query
Property methods: StatCommandsDisplayToLogical(), StatCommandsGet(), StatCommandsIsValid(), StatCommandsLogicalToDisplay(), StatCommandsNormalize(), StatCommandsSet(), StatCommandsXSDToLogical()
property StatCount as %Integer;
Total number of times we have recorded this query being run
Property methods: StatCountDisplayToLogical(), StatCountGet(), StatCountIsValid(), StatCountLogicalToDisplay(), StatCountNormalize(), StatCountSet(), StatCountXSDToLogical()
property StatFirst as %Date;
First day we recorded statistics from running this query
Property methods: StatFirstDisplayToLogical(), StatFirstGet(), StatFirstIsValid(), StatFirstLogicalToDisplay(), StatFirstLogicalToOdbc(), StatFirstLogicalToXSD(), StatFirstNormalize(), StatFirstOdbcToLogical(), StatFirstSet(), StatFirstXSDToLogical()
property StatRowCount as %Integer;
Total %ROWCOUNT from running this query
Property methods: StatRowCountDisplayToLogical(), StatRowCountGet(), StatRowCountIsValid(), StatRowCountLogicalToDisplay(), StatRowCountNormalize(), StatRowCountSet(), StatRowCountXSDToLogical()
property StatStdDev as %Double [ Calculated ];
Standard deviation of the time measurement for this query
Property methods: StatStdDevCompute(), StatStdDevDisplayToLogical(), StatStdDevGet(), StatStdDevIsValid(), StatStdDevLogicalToDisplay(), StatStdDevLogicalToXSD(), StatStdDevNormalize(), StatStdDevOdbcToLogical(), StatStdDevSQLCompute(), StatStdDevXSDToLogical()
property StatTotal as %Double;
Total time spent running this query
Property methods: StatTotalDisplayToLogical(), StatTotalGet(), StatTotalIsValid(), StatTotalLogicalToDisplay(), StatTotalLogicalToXSD(), StatTotalNormalize(), StatTotalOdbcToLogical(), StatTotalSet(), StatTotalXSDToLogical()
property StatVariance as %Double;
Variance in time from running this query
Property methods: StatVarianceDisplayToLogical(), StatVarianceGet(), StatVarianceIsValid(), StatVarianceLogicalToDisplay(), StatVarianceLogicalToXSD(), StatVarianceNormalize(), StatVarianceOdbcToLogical(), StatVarianceSet(), StatVarianceXSDToLogical()
property Statement as %String (COLLATION = "SQLSTRING", MAXLEN = 262144);
Property methods: StatementDisplayToLogical(), StatementGet(), StatementIsValid(), StatementLogicalToDisplay(), StatementLogicalToOdbc(), StatementNormalize(), StatementSet()
property Switch as %String (MAXLEN = 32);
Value of %switch when the statement was compiled
Property methods: SwitchDisplayToLogical(), SwitchGet(), SwitchIsValid(), SwitchLogicalToDisplay(), SwitchLogicalToOdbc(), SwitchNormalize(), SwitchSet()
property Timestamp as %TimeStamp;
Timestamp value for when the plan was saved.
Property methods: TimestampDisplayToLogical(), TimestampGet(), TimestampIsValid(), TimestampLogicalToDisplay(), TimestampLogicalToXSD(), TimestampNormalize(), TimestampOdbcToLogical(), TimestampSet(), TimestampXSDToLogical()
property UserName as %String;
$username at the time the query was built
Property methods: UserNameDisplayToLogical(), UserNameGet(), UserNameIsValid(), UserNameLogicalToDisplay(), UserNameLogicalToOdbc(), UserNameNormalize(), UserNameSet()
property Version as %String (MAXLEN = 200);
$zversion string for when the plan was saved.
Property methods: VersionDisplayToLogical(), VersionGet(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()

Methods

method GetBinaryPlan(plan) as %Status

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: SQLStorage

Maps: 1

  • Map number 1 is named Master

    thismap.Global: ^rINDEXSQL

  • ^rINDEXSQL("sqlidx",1,{Hash})
    =
    Node Delimiter Piece Name
    0 1 SqlComp
    0 2 SQLSchemaPath
    0 3 DefaultSchema
    0 4 Packages
    0 5 Switch
    StatementVersion
    2 1 UserName
    2 2 ClientName
    2 3 ClientIP
    2 4 ClientApp
    2 5 CallStack
    "err" Error
    "planinfo" 1 Frozen
    "planinfo" 2 Timestamp
    "planinfo" 3 Version
    "planinfo" 4 ParentHash
    "planinfo" 5 NaturalQuery
    "planinfo" 6 FrozenDifferent
    "planinfo" 7 FrozenScanHash
    "planinfo" 8 FrozenScanVersion
    "stat" 1 StatCount
    "stat" 2 StatTotal
    "stat" 3 StatVariance
    "stat" 4 StatFirst
    "stat" 5 StatRowCount
    "stat" 6 StatCommands
FeedbackOpens in a new tab