SAP ABAP Class CL_HDB_EXPLAIN_INSTANCE (HDB: Instance / Result of an EXPLAIN execution)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ HAN-DB (Application Component) SAP HANA Database
     ⤷ SDBA_HDB (Package) DBACOCKPIT for NewDB (HDB)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_DBA_EXPLAIN_INSTANCE	General Explain Instance	20120402

Properties

Class	CL_HDB_EXPLAIN_INSTANCE
Short Description	HDB: 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	SDBA_HDB	DBACOCKPIT for NewDB (HDB)
Created	20120402	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)

Interfaces

Class CL_HDB_EXPLAIN_INSTANCE has no interface implemented.

Friends

Class CL_HDB_EXPLAIN_INSTANCE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DBCNAME_2	Instance attribute	Private	☐	Type reference (TYPE)	DBCON_NAME		Logical name for a database connection	20121122
2	EXPLAIN_XML	Instance attribute	Private	☐	Type reference (TYPE)	STRING		HDB: strin which contains the xml file for the statement	20120515
3	GENERAL_DETAILS	Instance attribute	Private	☐	Type reference (TYPE)	DBAXPLDETOBJ_TAB		HDB: General Details Data	20120425
4	PLAN_TABLE_READ	Instance attribute	Private	☐	Type reference (TYPE)	HDB_EXPLAIN_PLAN_TAB		HDB: Table SYS.EXPLAIN_PLAN_TABLE	20120410
5	STATEMENT_NAME	Instance attribute	Private	☐	Type reference (TYPE)	HDB_SCHEMA_NAME		Statement name	20120404

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	20120411
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20120402
3	CREATE_XPLM_COLUMN	Instance method	Private	Method	HDB: create explain model column objects	20120502
4	CREATE_XPLM_INDEX	Instance method	Private	Method	HDB: create explain model index objects	20120503
5	GET_ACCESS_DETAILS	Instance method	Private	Method	HDB: Get Index Access Details	20120508
6	GET_ARGUMENT_DETAIL_ELEM	Instance method	Private	Method	HDB: get costs detail object for given operator id	20120416
7	GET_CATALOG_OBJECT_TABLE	Instance method	Private	Method	HDB: Build Table and Index Object Models	20120424
8	GET_COST_DETAIL_ELEM	Instance method	Private	Method	HDB: get costs detail object for given operator id	20120416
9	GET_JOIN_TYPE	Instance method	Private	Method	HDB: determine leg type of node (JOIN orders)	20120416
10	GET_NODE_DETAIL_INFO	Instance method	Private	Method	get argument list object for given operator	20120412
11	PARSE_XML_AND_BUILD_PLAN_NODES	Instance method	Private	Method	HDB: Paree XML and build plan nodes	20120515
12	READ_EXPLAIN_TABLES	Instance method	Private	Method	HDB: Read explain tables for statement id	20120404

Events

Class CL_HDB_EXPLAIN_INSTANCE has no event.

Types

Class CL_HDB_EXPLAIN_INSTANCE has no local type.

Method Signatures

Method BUILD_EXPLAIN_NODES Signature

Method BUILD_EXPLAIN_NODES on class CL_HDB_EXPLAIN_INSTANCE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DBA_ADBC	☐	DBA Cockpit: ADBC Errors	20120427

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DBCNAME_2	Call by reference	☑	Type reference (TYPE)	DBCON_NAME		Description of Database Connections	20121122
2	Importing	EXPLAIN_XML	Call by reference	☑	Type reference (TYPE)	STRING			20120515
3	Importing	STATEMENT_NAME	Call by reference	☑	Type reference (TYPE)	HDB_SCHEMA_NAME		Character field length 26	20120404
4	Importing	SYS_REF	Call by reference	☐	Object reference (TYPE REF TO)	CL_DB6_SYS		DB6: Remote System Administration	20120402

#	Exception	Resumable	Description	Created on
1	CX_DBA_ADBC	☐	DBA Cockpit: ADBC Errors	20120515
2	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20120515

Method CREATE_XPLM_COLUMN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COLUMNS_DEF	Call by reference	☐	Type reference (TYPE)	HDB_TABLE_COLUMNS_TAB		Table columns	20120504
2	Importing	INDEXES_DEF	Call by reference	☐	Type reference (TYPE)	HDB_INDEXES_TAB		Fields of views INDEXES joined with INDEX_COLUMNS	20120504
3	Returning	INVOLVED_COLUMNS	Value transfer	☐	Type reference (TYPE)	DBAXPLM_ICOL_TAB		DBA EXPLAIN Model: Table Column	20120504
4	Importing	SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20120502
5	Importing	TABLE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20120502

#	Exception	Resumable	Description	Created on
1	CX_DBA_ADBC	☐	DBA Cockpit: ADBC Errors	20120502

Method CREATE_XPLM_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INDEXES	Value transfer	☐	Type reference (TYPE)	DBAXPLM_IIX_TAB		DBA EXPLAIN Model: involved index list	20120503
2	Importing	INDEX_DESCR	Call by reference	☐	Type reference (TYPE)	HDB_INDEXES_TAB		Fields of views INDEXES joined with INDEX_COLUMNS	20120503
3	Importing	INVOLVED_COLUMNS	Call by reference	☐	Type reference (TYPE)	DBAXPLM_ICOL_TAB		DBA EXPLAIN Model: Table of DBAXPLM_ICOL	20120504
4	Importing	SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20120503
5	Importing	TABLE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20120503

Method CREATE_XPLM_INDEX on class CL_HDB_EXPLAIN_INSTANCE has no exception.

Method GET_ACCESS_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDEX_NAME	Value transfer	☑	Type reference (TYPE)	STRING			20120508
2	Changing	INVOLVED_COLUMNS	Call by reference	☐	Type reference (TYPE)	DBAXPLM_ICOL_TAB		DBA EXPLAIN Model: Table of DBAXPLM_ICOL	20120508
3	Changing	INVOLVED_INDEXES	Call by reference	☐	Type reference (TYPE)	DBAXPLM_IIX_TAB		DBA EXPLAIN Model: involved index list	20120508
4	Changing	KEY_COLCNT	Call by reference	☑	Type reference (TYPE)	I			20120508
5	Changing	KEY_COLS	Call by reference	☑	Type reference (TYPE)	STRING			20120508
6	Importing	OP_ID	Call by reference	☐	Type reference (TYPE)	I			20120508
7	Importing	SCHEMA_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20120508
8	Importing	TABLE_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20120508

#	Exception	Resumable	Description	Created on
1	CX_DBA_ADBC	☐	DBA Cockpit: ADBC Errors	20120508

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	20120416
2	Importing	IS_INDEX	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120426
3	Importing	OP_ID	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20120416

Method GET_ARGUMENT_DETAIL_ELEM on class CL_HDB_EXPLAIN_INSTANCE has no exception.

Method GET_CATALOG_OBJECT_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INVOLVED_COLUMNS	Call by reference	☐	Type reference (TYPE)	DBAXPLM_ICOL_TAB		DBA EXPLAIN Model: Table of DBAXPLM_ICOL	20120503
2	Importing	INVOLVED_INDEX	Call by reference	☐	Type reference (TYPE)	DBAXPLM_IIX_TAB		DBA EXPLAIN Model: involved index list	20120503
3	Importing	OP_ID	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20120424
4	Returning	TABLE_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_XPLM_TABLE		DBA EXPLAIN Model: Table	20120424

Method GET_CATALOG_OBJECT_TABLE on class CL_HDB_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	20120416
2	Importing	OP_ID	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20120416

Method GET_COST_DETAIL_ELEM on class CL_HDB_EXPLAIN_INSTANCE has no exception.

Method GET_JOIN_TYPE Signature

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

Method GET_JOIN_TYPE on class CL_HDB_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_DBA_XPLM_NODE_INFO		DBA Explain Model: Node Summary Info	20120412
2	Importing	OP_ID	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20120412

Method GET_NODE_DETAIL_INFO on class CL_HDB_EXPLAIN_INSTANCE has no exception.

Method PARSE_XML_AND_BUILD_PLAN_NODES Signature

Method PARSE_XML_AND_BUILD_PLAN_NODES on class CL_HDB_EXPLAIN_INSTANCE has no parameter.

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

Method READ_EXPLAIN_TABLES Signature

Method READ_EXPLAIN_TABLES on class CL_HDB_EXPLAIN_INSTANCE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DBA_ADBC	☐	DBA Cockpit: ADBC Errors	20120404

History

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