SAP ABAP Class CL_SYB_EXPLAIN_INSTANCE (SYB: Instance / Result of an EXPLAIN execution)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB-SYB (Application Component) Sybase ASE Database Platform
     ⤷ SMSYB (Package) SYBASE Database Monitor

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_DBA_EXPLAIN_INSTANCE	General Explain Instance	20101109
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DBA_EXPLAIN_EXTENDED_EDGES	DBA Explain: edge customizing	20101109
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DBA_EXPLAIN_TEXT_EXTENSION	DBA Cocpit: raw text extension for EXPLAIN UI	20101109
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SYB_EXPLAIN_OPTIMIZER_CFG	SYB Explain: Optimizer Configuration for Showplan	20110627

Properties

Class	CL_SYB_EXPLAIN_INSTANCE
Short Description	SYB: Instance / Result of an EXPLAIN execution
Super Class	CL_DBA_EXPLAIN_INSTANCE	General Explain Instance
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SMSYB	SYBASE Database Monitor
Created	20101109	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	ADBC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_DBA_EXPLAIN_EXTENDED_EDGES	☐	☐	DBA Explain: edge customizing	20101109
2	IF_DBA_EXPLAIN_TEXT_EXTENSION	☐	☐	DBA Cocpit: raw text extension for EXPLAIN UI	20101109
3	IF_SYB_EXPLAIN_OPTIMIZER_CFG	☐	☐	SYB Explain: Optimizer Configuration for Showplan	20110627

Friends

Class CL_SYB_EXPLAIN_INSTANCE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	COLGRPSTATS_ALV	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DB6_ALV		DB6: simple ALV abstraction	20110429
2	COLHISTOGRAM_ALV	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DB6_ALV		DB6: simple ALV abstraction	20110429
3	EXPLAIN_XML	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101109
4	GENERAL_DETAILS	Instance attribute	Private	☐	Type reference (TYPE)	DBAXPLDETOBJ_TAB		EXPLAIN: Table of DBAXPLDETOBJ	20101112
5	INVOLVED_COLUMNS	Instance attribute	Private	☐	Type reference (TYPE)	DBAXPLM_ICOL_TAB		DBA EXPLAIN Model: Table of DBAXPLM_ICOL	20101119
6	INVOLVED_INDEXES	Instance attribute	Private	☐	Type reference (TYPE)	DBAXPLM_IIX_TAB		DBA EXPLAIN Model: involved index list	20101117
7	INVOLVED_TABLES	Instance attribute	Private	☐	Type reference (TYPE)	DBAXPLM_ITAB_TAB		DBA EXPLAIN Model: involved table list	20101117
8	MAX_ACT_ROWS	Instance attribute	Private	☐	Type reference (TYPE)	SYBBIGINT			20101116
9	MAX_EST_ROWS	Instance attribute	Private	☐	Type reference (TYPE)	SYBBIGINT			20101116
10	NODE_ROWCOUNTS	Instance attribute	Private	☐	Type reference (TYPE)	L_NODE_ROWCNT_TAB			20101116
11	SSQLID	Instance attribute	Private	☐	Type reference (TYPE)	I			20101115
12	STMT_TEXT	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101115
13	VALUE_SETS	Instance attribute	Private	☐	Type reference (TYPE)	DBAXPLVALUESETOBJ_TAB		DBA Explain: Table of DBAXPLVALUESETOBJ	20101115

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_PLAN_NODES	Instance method	Private	Method		20101115
2	BUILD_PREDICATES	Instance method	Private	Method		20130306
3	BUILD_REFERRED_OBJECTS	Instance method	Private	Method		20101117
4	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20101109
5	CREATE_GENERAL_DETAILS	Instance method	Private	Method		20101112
6	CREATE_IXACCESS_DETAIL_OBJ	Instance method	Private	Method		20101117
7	CREATE_METRICS_DETAIL_OBJ	Instance method	Private	Method		20101115
8	CREATE_PARAMETER_SET	Instance method	Private	Method		20101112
9	CREATE_SUMMARY_NODE_INFO	Instance method	Private	Method		20101116
10	CREATE_XPLM_COLUMN	Instance method	Private	Method		20101122
11	CREATE_XPLM_INDEX	Instance method	Private	Method		20101124
12	CREATE_XPLM_TABLE	Instance method	Private	Method		20101117
13	DETERMINE_FULL_OBJNAME	Instance method	Private	Method		20110815
14	GET_DBNAME	Instance method	Public	Method		20110627
15	GET_IXSCAN_BY_KEY_COLUMNS	Instance method	Private	Method		20110113
16	GET_NODE_ID	Instance method	Private	Method		20130528
17	GET_NONDEF_DETAIL	Instance method	Private	Method		20101117
18	GET_PARAMETER_SETS_FOR_SHMA	Instance method	Public	Method		20110630
19	GET_USER	Instance method	Public	Method		20110627
20	PARSE_EXECTREE_NODE	Instance method	Private	Method		20130306
21	PARSE_OPTREE_NODE	Instance method	Private	Method		20130306
22	PARSE_REFERRED_OBJECTS	Instance method	Private	Method		20101117
23	PARSE_STMT_TEXT	Instance method	Private	Method		20101115
24	PARSE_XML_AND_BUILD_PLAN_NODES	Instance method	Private	Method		20101111
25	SET_GRID_ATTRIBUTES_COLGRPSTAT	Instance method	Private	Method		20110429
26	SET_GRID_ATTRIBUTES_COLHIST	Instance method	Private	Method		20110429

Events

Class CL_SYB_EXPLAIN_INSTANCE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	L_IXML_NODE_TAB	Private	See coding			20101117	L_IXML_NODE_TAB type standard table of ref to IF_IXML_NODE
2	L_NODE_ROWCNT	Private	See coding			20101116	begin of L_NODE_ROWCNT, node_id type i, type type string, rowcnt type sybbigint, end of L_NODE_ROWCNT
3	L_NODE_ROWCNT_TAB	Private	See coding			20101116	L_NODE_ROWCNT_TAB type standard table of L_NODE_ROWCNT

Method Signatures

Method BUILD_PLAN_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OPTREE_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20101115

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20101115

Method BUILD_PREDICATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXECTREE_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		Node of DOM	20130306

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20130306

Method BUILD_REFERRED_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OPTREE_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20101117

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20101117

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DBNAME	Call by reference	☐	Type reference (TYPE)	SYBDBNAME		SYB: DB Name	20111215
2	Importing	EXPLAIN_XML	Call by reference	☐	Type reference (TYPE)	STRING			20101109
3	Importing	PLAN_TYPE	Call by reference	☐	Type reference (TYPE)	I			20111123
4	Importing	SSQLID	Call by reference	☐	Type reference (TYPE)	I			20101115
5	Importing	SYS_REF	Call by reference	☐	Object reference (TYPE REF TO)	CL_DB6_SYS		DB6: Remote System Administration	20101109
6	Importing	USER	Call by reference	☐	Type reference (TYPE)	SYBOBJOWNER		SYB: Object Owner (Index, Table, DB, Partition, ...)	20111215

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20101112

Method CREATE_GENERAL_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DETAILS	Call by reference	☐	Type reference (TYPE)	DBAKEYVAL_TAB		DBA Cockpit: Table of DBAKEYVAL	20101112

Method CREATE_GENERAL_DETAILS on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method CREATE_IXACCESS_DETAIL_OBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DETAILS_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_NODEDETAILS		EXPLAIN detail table	20101117
2	Importing	DETAIL_NODES	Call by reference	☐	Type reference (TYPE)	L_IXML_NODE_TAB			20101117
3	Importing	NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20101117

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20101117

Method CREATE_METRICS_DETAIL_OBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DETAILS_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_NODEDETAILS		EXPLAIN detail table	20101115
2	Changing	NODEINFOS	Call by reference	☐	Type reference (TYPE)	DBAKEYVAL_TAB		DBA Cockpit: Table of DBAKEYVAL	20101115
3	Importing	NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20101116
4	Importing	XML_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20101115

Method CREATE_METRICS_DETAIL_OBJ on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method CREATE_PARAMETER_SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20101112

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20101112

Method CREATE_SUMMARY_NODE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NODE_INFO	Value transfer	☐	Object reference (TYPE REF TO)	CL_SYB_XPLM_NODE_INFO		DBA Explain Model: SYB Node Summary Info	20101116
2	Importing	SUMMARY_NODES	Call by reference	☐	Type reference (TYPE)	L_IXML_NODE_TAB			20120306

Method CREATE_SUMMARY_NODE_INFO on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method CREATE_XPLM_COLUMN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COLSTATS	Call by reference	☐	Type reference (TYPE)	SYB_COLSTATS			20110429
2	Importing	COLUMN_DESCR	Call by reference	☐	Type reference (TYPE)	ADBC_TABCOL_DESCR			20101122
3	Returning	COLUMN_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_COLUMN			20101122
4	Importing	DBNAME	Call by reference	☐	Type reference (TYPE)	SYBDBNAME		SYB: DB Name	20101122
5	Importing	KEY_SEQUENCE	Call by reference	☐	Type reference (TYPE)	I			20101122
6	Importing	TABNAME	Call by reference	☐	Type reference (TYPE)	STRING			20101122
7	Importing	TABOWNER	Call by reference	☐	Type reference (TYPE)	STRING			20101122

Method CREATE_XPLM_COLUMN on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method CREATE_XPLM_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COLUMNS	Call by reference	☐	Type reference (TYPE)	ADBC_INDCOL_DESCR_TAB			20101124
2	Importing	DBNAME	Call by reference	☐	Type reference (TYPE)	SYBDBNAME			20101124
3	Importing	INDEX_DESCR	Call by reference	☐	Type reference (TYPE)	SYB_SYSINDEXES		SYB: ..sysindexes	20101124
4	Returning	INDEX_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_INDEX			20101124
5	Importing	INDNAME	Call by reference	☐	Type reference (TYPE)	STRING			20101124
6	Importing	INDSTATS	Call by reference	☐	Type reference (TYPE)	SYB_INDSTATS			20110502
7	Importing	TABNAME	Call by reference	☐	Type reference (TYPE)	STRING			20101124
8	Importing	TABOWNER	Call by reference	☐	Type reference (TYPE)	STRING			20101124

Method CREATE_XPLM_INDEX on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method CREATE_XPLM_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DBNAME	Call by reference	☐	Type reference (TYPE)	SYBDBNAME		SYB: DB Name	20101117
2	Importing	ISTEMPWT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20110812
3	Returning	TABLE_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_TABLE		DBA EXPLAIN Model: Table	20101117
4	Importing	TABNAME	Call by reference	☐	Type reference (TYPE)	STRING			20101117
5	Importing	TABOWNER	Call by reference	☐	Type reference (TYPE)	STRING			20101117

#	Exception	Resumable	Description	Created on
1	CX_DBA_ADBC	☐	DBA Cockpit: ADBC Errors	20101122
2	CX_DBA_RDI	☐	DBA-RDI: General Back-end Error	20101122

Method DETERMINE_FULL_OBJNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DBNAME	Call by reference	☐	Type reference (TYPE)	SYBDBNAME		SYB: DB Name	20110815
2	Importing	OBJ_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20110815
3	Exporting	TABNAME	Call by reference	☐	Type reference (TYPE)	STRING			20110815
4	Exporting	TABOWNER	Call by reference	☐	Type reference (TYPE)	STRING			20110815

Method DETERMINE_FULL_OBJNAME on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method GET_DBNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DBNAME	Value transfer	☐	Type reference (TYPE)	SYBDBNAME		SYB: DB Name	20110627

Method GET_DBNAME on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method GET_IXSCAN_BY_KEY_COLUMNS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DETAIL_NODES	Call by reference	☐	Type reference (TYPE)	L_IXML_NODE_TAB			20110113
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING			20110113

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20110113

Method GET_NODE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NODE_ID	Value transfer	☐	Type reference (TYPE)	I			20130528
2	Importing	VA_NUM	Call by reference	☐	Type reference (TYPE)	I			20130528

Method GET_NODE_ID on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method GET_NONDEF_DETAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DETAIL_NODES	Call by reference	☐	Type reference (TYPE)	L_IXML_NODE_TAB			20101117
2	Importing	NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20101117
3	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20101117

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20101117

Method GET_PARAMETER_SETS_FOR_SHMA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	VALUE_SETS	Value transfer	☐	Type reference (TYPE)	SYB_OPTDIAG_VALUE_SET_TAB		SYB: Table of SYB_OPTDIAG_VALUE_SET	20110630

Method GET_PARAMETER_SETS_FOR_SHMA on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method GET_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	USER	Value transfer	☐	Type reference (TYPE)	SYBOBJOWNER		SYB: Object Owner (Index, Table, DB, Partition, ...)	20110627

Method GET_USER on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method PARSE_EXECTREE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PLAN_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20130306

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20130306

Method PARSE_OPTREE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARENT_ID	Call by reference	☐	Type reference (TYPE)	I			20130306
2	Importing	PLAN_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20130306
3	Importing	TREE_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20130306

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20130306

Method PARSE_REFERRED_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	XML_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20101117

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20101117

Method PARSE_STMT_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	STMT_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20101115
2	Importing	TEXT_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20101115

Method PARSE_STMT_TEXT on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method PARSE_XML_AND_BUILD_PLAN_NODES Signature

Method PARSE_XML_AND_BUILD_PLAN_NODES on class CL_SYB_EXPLAIN_INSTANCE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20101111

Method SET_GRID_ATTRIBUTES_COLGRPSTAT Signature

Method SET_GRID_ATTRIBUTES_COLGRPSTAT on class CL_SYB_EXPLAIN_INSTANCE has no parameter.
Method SET_GRID_ATTRIBUTES_COLGRPSTAT on class CL_SYB_EXPLAIN_INSTANCE has no exception.

Method SET_GRID_ATTRIBUTES_COLHIST Signature

Method SET_GRID_ATTRIBUTES_COLHIST on class CL_SYB_EXPLAIN_INSTANCE has no parameter.
Method SET_GRID_ATTRIBUTES_COLHIST on class CL_SYB_EXPLAIN_INSTANCE has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	703