SAP ABAP Class CL_DB6_EXPLAIN_INSTANCE (DB6: Instance / Result of an EXPLAIN execution)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB-DB6 (Application Component) DB2 Universal Database for UNIX / NT
     ⤷ STU6 (Package) DB6: Performance-Monitor (UNIX/Windows)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_DBA_EXPLAIN_INSTANCE	General Explain Instance	20070924
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DB6_EXPLAIN_OPTIMIZER_CFG	DB6 Explain: Optimizer Configuration for EXPLAIN	20080407
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DBA_EXPLAIN_BATCH_CALC		20070315
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DBA_EXPLAIN_CALC_RRR_ALL	DBA Explain: calculation of real rows returned for all nodes	20070315
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DBA_EXPLAIN_EXTENDED_EDGES	DBA Explain: edge customizing	20080221
6	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DBA_EXPLAIN_TEXT_EXTENSION	DBA Cocpit: raw text extension for EXPLAIN UI	20070910
7	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SERIALIZABLE_OBJECT	Serializable Object	20070405

Properties

Class	CL_DB6_EXPLAIN_INSTANCE
Short Description	DB6: 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	STU6	DB6: Performance-Monitor (UNIX/Windows)
Created	20060621	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	DB6SY	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_DB6_EXPLAIN_OPTIMIZER_CFG	☐	☐	DB6 Explain: Optimizer Configuration for EXPLAIN	20080407
2	IF_DBA_EXPLAIN_BATCH_CALC	☐	☐		20070315
3	IF_DBA_EXPLAIN_CALC_RRR_ALL	☐	☐	DBA Explain: calculation of real rows returned for all nodes	20070315
4	IF_DBA_EXPLAIN_EXTENDED_EDGES	☐	☐	DBA Explain: edge customizing	20080221
5	IF_DBA_EXPLAIN_TEXT_EXTENSION	☐	☐	DBA Cocpit: raw text extension for EXPLAIN UI	20070910
6	IF_SERIALIZABLE_OBJECT	☐	☐	Serializable Object	20070405

Friends

Class CL_DB6_EXPLAIN_INSTANCE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ADVISOR_MODE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20080619
2	COLDIST_ALV	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DB6_ALV		DB6: simple ALV abstraction	20080630
3	COLGRP_ALV	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DB6_ALV		DB6: simple ALV abstraction	20080630
4	COLUMN_ALIASES	Instance attribute	Public	☐	Type reference (TYPE)	DBAKEYVAL_TAB		DBA Cockpit: Table of DBAKEYVAL	20061227
5	DIAGNOSTIC	Instance attribute	Public	☐	Type reference (TYPE)	DB6XPLDIAG_TAB		DB6: Table of DB6XPLDIAG	20060621
6	EEE_FLAG	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20060623
7	EXPLAIN_ARGUMENT	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLARGU_TAB		DB6: Table of DB6XPLARGU	20060621
8	EXPLAIN_INSTANCE	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLINST_TAB		DB6: Table of DB6XPLINST	20060621
9	EXPLAIN_OBJECT	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLOBJ_TAB		DB6: Table of DB6XPLOBJ	20060621
10	EXPLAIN_OPERATOR	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLOPER_TAB		DB6: Table of DB6XPLOPER	20060621
11	EXPLAIN_PREDICATE	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLPRED_TAB		DB6: Table of DB6XPLPRED	20060621
12	EXPLAIN_SCHEMA	Instance attribute	Private	☐	Type reference (TYPE)	DB6SCHEMA		DB6: Schema Name	20060623
13	EXPLAIN_STATEMENT	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLSTMT_TAB		DB6: Table of DB6XPLSTMT	20060621
14	EXPLAIN_STREAM	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLSTRM_TAB		DB6: Table of DB6XPLSTRM	20060621
15	EXPLAIN_TIME	Instance attribute	Private	☐	Type reference (TYPE)	CHAR26		DB6: Timestamp (Format: YYYYMMDDHHMMSS)	20060623
16	GENERAL_DETAILS	Instance attribute	Private	☐	Type reference (TYPE)	DBAXPLDETOBJ_TAB		EXPLAIN: Table of DBAXPLDETOBJ	20061004
17	INVOLVED_COLUMNS	Instance attribute	Private	☐	Type reference (TYPE)	DBAXPLM_ICOL_TAB		DBA EXPLAIN Model: Table of DBAXPLM_ICOL	20061027
18	INVOLVED_INDEXES	Instance attribute	Private	☐	Type reference (TYPE)	DBAXPLM_IIX_TAB		DBA EXPLAIN Model: involved index list	20061017
19	INVOLVED_TABLES	Instance attribute	Private	☐	Type reference (TYPE)	DBAXPLM_ITAB_TAB		DBA EXPLAIN Model: involved table list	20061017
20	REAL_ROWS_RET_CALC_POSSIBLE	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL			20061228
21	SYSCOLDIST	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLCOLDIST_TAB		DB6: Table of DB6XPLCOLDIST	20070405
22	SYSCOLGROUPCOLS	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLCOLGROUPCOLS_TAB		DB6: Table of DB6XPLCOLGROUPCOLS	20080625
23	SYSCOLGROUPDIST	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLCOLGROUPDIST_TAB		DB6: Table of DB6XPLCOLGROUPDIST	20080625
24	SYSCOLGROUPDISTCNTS	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLCOLGROUPDISTCNT_TAB		DB6: Table of DB6XPLCOLGROUPDISTCNT	20080625
25	SYSCOLGROUPS	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLCOLGROUP_TAB		DB6: Table of DB6XPLCOLGROUP	20080625
26	SYSCOLUMNS	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLCOLS_TAB		DB6: structure on SYSCAT.COLUMNS	20060621
27	SYSINDEXCOLS	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLIXCOLS_TAB		DB6: Table of DB6XPLIXCOLS	20061030
28	SYSINDEXES	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLINDX_TAB		DB6: Table of DB6XPLINDX	20060621
29	SYSNODES	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLNODE_TAB		DB6: EXPLAIN: syscat.nodegroups+syscat.nodegroupdef	20060621
30	SYSSTATSVIEWS	Instance attribute	Private	☐	Type reference (TYPE)	DB6XPLVIEW_TAB		DB6: Table of DB6XPLTABL	20080630
31	SYSTABLES	Instance attribute	Public	☐	Type reference (TYPE)	DB6XPLTABL_TAB		DB6: Table of DB6XPLTABL	20060621
32	TABLE_ALIASES	Instance attribute	Public	☐	Type reference (TYPE)	DBAKEYVAL_TAB		ABAP HashMap	20061220

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_EXPLAIN_NODES	Instance method	Private	Method	build key table with EXPLAIN objects for XML generation	20061016
2	BUILD_EXPLAIN_OBJECTS	Instance method	Private	Method	build table and index object models	20061016
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20060621
4	CREATE_XPLM_COLUMN	Instance method	Private	Method	create EXPLAIN model table object	20061027
5	CREATE_XPLM_INDEX	Instance method	Private	Method	create EXPLAIN model table object	20061017
6	CREATE_XPLM_TABLE	Instance method	Private	Method	create EXPLAIN model table object	20061017
7	CREATE_XPLM_VIEW	Instance method	Private	Method	create EXPLAIN model table object	20080701
8	CUT_COLUMN_ALIASES	Instance method	Private	Method	cut column aliases used in optimized statement	20061227
9	CUT_SELECT_FIELD_LIST	Instance method	Private	Method	cut field list from SELECT	20061227
10	CUT_TABLE_ALIASES	Instance method	Private	Method	cut table aliases from optimized statement	20061220
11	FOLLOW_VIRTUAL_COLUMN_NAME	Instance method	Private	Method	follow virtual column name up to its 'real' name	20061227
12	GET_ARGUMENT_DETAIL_ELEM	Instance method	Private	Method	get argument list object for given operator	20061009
13	GET_COST_DETAIL_ELEM	Instance method	Private	Method	get argument list object for given operator	20061009
14	GET_EXPLAIN_ARGUMENT	Instance method	Public	Method		20070321
15	GET_IXACCESS_DETAILS	Instance method	Private	Method	select key columns used for IXSCAN	20070927
16	GET_NODE_DETAIL_INFO	Instance method	Private	Method	get argument list object for given operator	20070207
17	GET_PREDICATES	Instance method	Private	Method	get argument list object for given operator	20061024
18	GET_ROWSRET_DETAIL_ELEM	Instance method	Private	Method	get number of rows returned detail element	20061109
19	GET_SUMMARY_INFO	Instance method	Private	Method	get argument list object for given operator	20100422
20	NEXT_PARENT_LEG_TYPE	Instance method	Private	Method	determine next upcoming leg type (INNER or OUTER)	20080225
21	READ_EXPLAIN_TABLES	Instance method	Private	Method	DB6: read EXPLAIN tables for instance execution ID	20060621
22	SET_GRID_ATTRIBUTES_COLDIST	Instance method	Private	Method	set ALV grid attributes	20080630
23	SET_GRID_ATTRIBUTES_COLGRP	Instance method	Private	Method	set ALV grid attributes	20080630

Events

Class CL_DB6_EXPLAIN_INSTANCE has no event.

Types

Class CL_DB6_EXPLAIN_INSTANCE has no local type.

Method Signatures

Method BUILD_EXPLAIN_NODES Signature

Method BUILD_EXPLAIN_NODES on class CL_DB6_EXPLAIN_INSTANCE has no parameter.
Method BUILD_EXPLAIN_NODES on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method BUILD_EXPLAIN_OBJECTS Signature

Method BUILD_EXPLAIN_OBJECTS on class CL_DB6_EXPLAIN_INSTANCE has no parameter.
Method BUILD_EXPLAIN_OBJECTS on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADVISOR_MODE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	DB6: Timestamp (Format: YYYYMMDDHHMMSS)	20080619
2	Importing	EXPLAIN_SCHEMA	Call by reference	☐	Type reference (TYPE)	DB6SCHEMA		DB6: Schema Name	20060622
3	Importing	EXPLAIN_TIME	Call by reference	☐	Type reference (TYPE)	CHAR26		Character field length 26	20070214
4	Importing	SYS_REF	Call by reference	☐	Object reference (TYPE REF TO)	CL_DB6_SYS		DB6: Remote System Administration	20070208

#	Exception	Resumable	Description	Created on
1	CX_DBA_ADBC	☐	DBA Cockpit: ADBC-Fehler	20060712

Method CREATE_XPLM_COLUMN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COLUMN_DESCR	Call by reference	☐	Type reference (TYPE)	DB6XPLCOLS		DB6: structure on SYSCAT.COLUMNS	20061027
2	Returning	COLUMN_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_COLUMN			20061027

Method CREATE_XPLM_COLUMN on class CL_DB6_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	INDEX_DESCR	Call by reference	☐	Type reference (TYPE)	DB6XPLINDX			20061017
2	Returning	INDEX_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_INDEX		DBA EXPLAIN Model: Table	20061017

Method CREATE_XPLM_INDEX on class CL_DB6_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	TABLE_DESCR	Call by reference	☐	Type reference (TYPE)	DB6XPLTABL			20070208
2	Returning	TABLE_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_TABLE		DBA EXPLAIN Model: Table	20061017

Method CREATE_XPLM_TABLE on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method CREATE_XPLM_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TABLE_DESCR	Call by reference	☐	Type reference (TYPE)	DB6XPLVIEW		DB6: extension of DB6XPLTABL for stats views	20080701
2	Returning	VIEW_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_TABLE		DBA EXPLAIN Model: Table	20080701

Method CREATE_XPLM_VIEW on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method CUT_COLUMN_ALIASES Signature

Method CUT_COLUMN_ALIASES on class CL_DB6_EXPLAIN_INSTANCE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DBA_PARSE_ERROR	☐	general parse error	20070209
2	CX_DBA_XPL_ACTION_UNSUPPORTED	☐	throw if action not possible/unsupported	20061227

Method CUT_SELECT_FIELD_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	FIELD_LIST	Value transfer	☐	Type reference (TYPE)	DBAKEYVAL_TAB		DBA Cockpit: Table of DBAKEYVAL	20061227
2	Importing	SELECT_STMT	Call by reference	☐	Type reference (TYPE)	STRING			20061227

#	Exception	Resumable	Description	Created on
1	CX_DBA_PARSE_ERROR	☐	throw if action not possible/unsupported	20061227
2	CX_DBA_XPL_ACTION_UNSUPPORTED	☐	throw if action not possible/unsupported	20061227

Method CUT_TABLE_ALIASES Signature

Method CUT_TABLE_ALIASES on class CL_DB6_EXPLAIN_INSTANCE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DBA_PARSE_ERROR	☐	general parse error	20101012
2	CX_DBA_XPL_ACTION_UNSUPPORTED	☐	throw if action not possible/unsupported	20061227

Method FOLLOW_VIRTUAL_COLUMN_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	REAL_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20061227
2	Importing	VIRTUAL_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20061227

#	Exception	Resumable	Description	Created on
1	CX_DBA_PARSE_ERROR	☐	general parse error	20061227
2	CX_DBA_XPL_ACTION_UNSUPPORTED	☐	throw if action not possible/unsupported	20061227

Method GET_ARGUMENT_DETAIL_ELEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DETAIL_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_NODEDETAILS		EXPLAIN detail table	20061009
2	Importing	OPER_ID	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20061009

Method GET_ARGUMENT_DETAIL_ELEM on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method GET_COST_DETAIL_ELEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DETAIL_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_NODEDETAILS		EXPLAIN detail table	20061009
2	Importing	OPER_ID	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20061009

Method GET_COST_DETAIL_ELEM on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method GET_EXPLAIN_ARGUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ARGUMENT_TAB	Value transfer	☐	Type reference (TYPE)	DB6XPLARGU_TAB		DB6: Table of DB6XPLARGU	20070321
2	Importing	NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20070321

Method GET_EXPLAIN_ARGUMENT on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method GET_IXACCESS_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDNAME	Call by reference	☐	Type reference (TYPE)	DB6XPLIXCOLS-INDNAME			20070927
2	Importing	INDSCHEMA	Call by reference	☐	Type reference (TYPE)	DB6XPLIXCOLS-INDSCHEMA			20070927
3	Exporting	KEY_COLCNT	Call by reference	☐	Type reference (TYPE)	I			20070927
4	Exporting	KEY_COLS	Call by reference	☐	Type reference (TYPE)	STRING			20070927
5	Importing	OPER_ID	Call by reference	☐	Type reference (TYPE)	I			20070927
6	Importing	TABNAME	Call by reference	☐	Type reference (TYPE)	STRING		DB6: structure of SYSCAT.INDEXCOLUSE	20070928

Method GET_IXACCESS_DETAILS on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method GET_NODE_DETAIL_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_DB6_XPLM_NODE_INFO		EXPLAIN detail table	20070207
2	Importing	OPER_ID	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20070207

Method GET_NODE_DETAIL_INFO on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method GET_PREDICATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OPER_ID	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20061024
2	Returning	PREDICATES	Value transfer	☐	Type reference (TYPE)	DBAXPLPREDOBJ_TAB		operator predicates	20061024

Method GET_PREDICATES on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method GET_ROWSRET_DETAIL_ELEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OPER_ID	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20061109
2	Returning	ROWSRET_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_NODEDETAILS		EXPLAIN detail table	20061109

Method GET_ROWSRET_DETAIL_ELEM on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method GET_SUMMARY_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_DB6_XPLM_NODE_INFO		EXPLAIN detail table	20100422

Method GET_SUMMARY_INFO on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method NEXT_PARENT_LEG_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NEXT_PARENT_LEG_TYPE	Value transfer	☐	Type reference (TYPE)	STRING			20080225
2	Importing	OPERATOR_ID	Call by reference	☐	Type reference (TYPE)	I			20080225

Method NEXT_PARENT_LEG_TYPE on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method READ_EXPLAIN_TABLES Signature

Method READ_EXPLAIN_TABLES on class CL_DB6_EXPLAIN_INSTANCE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DBA_ADBC	☐	DBA Cockpit: ADBC-Fehler	20060623

Method SET_GRID_ATTRIBUTES_COLDIST Signature

Method SET_GRID_ATTRIBUTES_COLDIST on class CL_DB6_EXPLAIN_INSTANCE has no parameter.
Method SET_GRID_ATTRIBUTES_COLDIST on class CL_DB6_EXPLAIN_INSTANCE has no exception.

Method SET_GRID_ATTRIBUTES_COLGRP Signature

Method SET_GRID_ATTRIBUTES_COLGRP on class CL_DB6_EXPLAIN_INSTANCE has no parameter.
Method SET_GRID_ATTRIBUTES_COLGRP on class CL_DB6_EXPLAIN_INSTANCE has no exception.

History

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