SAP ABAP Class CL_SYB_EXPLAIN_FACILITY (SYB CCMS: EXPLAIN backend)

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_FACILITY	DBA Cockpit: EXPLAIN Facility	20111110
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DBA_EXPLAIN_FACILITY	DBA EXPLAIN Model: EXPLAIN facility	20111110
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DBA_EXPLAIN_MODES	DBA EXPLAIN: Explain modes	20111128
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DBA_EXPLAIN_OSS_DOWNLOAD	DBA Explain: Availability of OSS Download Option	20110616
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DBA_EXPLAIN_PLAN_VERSIONS	DBA Explain: Extension IF for multiple plan versions	20101110
6	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DBA_EXPLAIN_WITH_VALUES	DBA EXPLAIN: Explain/Test Execute with bind values	20111124
7	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SYB_EXPLAIN_OPTIMIZER_CFG	SYB Explain: Optimizer Configuration for Showplan	20110627

Properties

Class	CL_SYB_EXPLAIN_FACILITY
Short Description	SYB CCMS: EXPLAIN backend
Super Class	CL_DBA_EXPLAIN_FACILITY	DBA Cockpit: EXPLAIN Facility
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	SMSYB	SYBASE Database Monitor
Created	20101029	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

#	Interface	Abstract	Final	Description	Created on
1	IF_DBA_EXPLAIN_FACILITY	☐	☐	DBA EXPLAIN Model: EXPLAIN facility	20111110
2	IF_DBA_EXPLAIN_MODES	☐	☐	DBA EXPLAIN: Explain modes	20111128
3	IF_DBA_EXPLAIN_OSS_DOWNLOAD	☐	☐	DBA Explain: Availability of OSS Download Option	20110616
4	IF_DBA_EXPLAIN_PLAN_VERSIONS	☐	☐	DBA Explain: Extension IF for multiple plan versions	20101110
5	IF_DBA_EXPLAIN_WITH_VALUES	☐	☐	DBA EXPLAIN: Explain/Test Execute with bind values	20111124
6	IF_SYB_EXPLAIN_OPTIMIZER_CFG	☐	☐	SYB Explain: Optimizer Configuration for Showplan	20110627

Friends

#	Friend	Modeled only	Created on	Description
1	CL_DBA_EXPLAIN_FACILITY	☐	20111111	DBA Cockpit: EXPLAIN Facility

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	AVAILABLE_PLAN_VERSIONS	Instance attribute	Private	☐	Type reference (TYPE)	DBAXPLPLANVERSION_TAB		DBA Explain: Table of DBAXPLPLANVERSION	20110217
2	CO_EXPLAIN_MODE_CACHE	Constant	Public	☐	Type reference (TYPE)	STRING	'__FROMCACHE__'		20111128
3	CO_EXPLAIN_MODE_RUNTIME	Constant	Public	☐	Type reference (TYPE)	STRING	'__NEWPLAN__'		20111128
4	XPL_MODES_TAB	Instance attribute	Private	☐	Type reference (TYPE)	DBAKEYVAL_TAB		DBA Cockpit: Table of DBAKEYVAL	20120105

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ATTACH_PLAN_HINTS	Static method	Public	Method		20120105
2	CONSTRUCTOR	Instance method	Protected	Constructor	CONSTRUCTOR	20101109
3	DETERMINE_PLAN_HINTS	Static method	Public	Method		20111220
4	DETERMINE_PLAN_VERSIONS	Instance method	Private	Method		20110217
5	GET_SSQLID_FOR_PLANID	Static method	Public	Method		20110110
6	HASH_SIMPLE_PLAN	Instance method	Private	Method		20110610
7	HAS_ON_DISK_QUERY_PLAN	Instance method	Private	Method		20121017
8	IS_VALID_PLAN_HINT	Static method	Public	Method		20120105
9	LOAD_DEF_OPTIMIZER_PARAMETERS	Instance method	Private	Method		20111215
10	PARSE_BIND_PARAMS	Static method	Public	Method		20120110
11	PARSE_BIND_PARAM_SETS	Instance method	Private	Method		20120110
12	PERFORM_EXPLAIN_FROM_CACHE	Instance method	Private	Method		20101110
13	PERFORM_RUNTIME_EXPLAIN	Instance method	Private	Method		20111109

Events

Class CL_SYB_EXPLAIN_FACILITY has no event.

Types

Class CL_SYB_EXPLAIN_FACILITY has no local type.

Method Signatures

Method ATTACH_PLAN_HINTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STMT_WITHOUT_HINTS	Call by reference	☐	Type reference (TYPE)	STRING			20120105
2	Returning	STMT_WITH_HINTS	Value transfer	☐	Type reference (TYPE)	STRING			20120105
3	Importing	SYB_OPT_CFG	Call by reference	☐	Object reference (TYPE REF TO)	IF_SYB_EXPLAIN_OPTIMIZER_CFG		SYB Explain: Optimizer Configuration for Showplan	20120105

Method ATTACH_PLAN_HINTS on class CL_SYB_EXPLAIN_FACILITY has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SYS_REF	Call by reference	☐	Object reference (TYPE REF TO)	CL_DB6_SYS		DB6: Remote System Administration	20101109

Method CONSTRUCTOR on class CL_SYB_EXPLAIN_FACILITY has no exception.

Method DETERMINE_PLAN_HINTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	PLAN_OPT_GOAL	Call by reference	☐	Type reference (TYPE)	STRING			20111220
2	Exporting	PLAN_OPT_HINT	Call by reference	☐	Type reference (TYPE)	STRING			20111220
3	Exporting	PLAN_OPT_LEVEL	Call by reference	☐	Type reference (TYPE)	STRING			20111220
4	Exporting	PLAN_OPT_TIMEOUT	Call by reference	☐	Type reference (TYPE)	I			20111220
5	Exporting	PLAN_PARALLELISM	Call by reference	☐	Type reference (TYPE)	I			20111220
6	Importing	STATEMENT	Call by reference	☐	Type reference (TYPE)	STRING			20111220
7	Exporting	STMT_WITHOUT_HINTS	Call by reference	☐	Type reference (TYPE)	STRING			20120104

Method DETERMINE_PLAN_HINTS on class CL_SYB_EXPLAIN_FACILITY has no exception.

Method DETERMINE_PLAN_VERSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STMT_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20110217

Method DETERMINE_PLAN_VERSIONS on class CL_SYB_EXPLAIN_FACILITY has no exception.

Method GET_SSQLID_FOR_PLANID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INSTANCEID	Call by reference	☐	Type reference (TYPE)	SYBMON_CACHEDPROC-INSTANCEID			20110110
2	Importing	PLANID	Call by reference	☐	Type reference (TYPE)	SYBMON_CACHEDPROC-PLANID			20110110
3	Returning	SSQLID	Value transfer	☐	Type reference (TYPE)	SYBMON_CACHEDSTMT-SSQLID			20110110
4	Importing	SYS_REF	Call by reference	☐	Object reference (TYPE REF TO)	CL_DB6_SYS		DB6: Remote System Administration	20110110

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

Method HASH_SIMPLE_PLAN Signature

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

Method HASH_SIMPLE_PLAN on class CL_SYB_EXPLAIN_FACILITY has no exception.

Method HAS_ON_DISK_QUERY_PLAN 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	20121017
2	Returning	HAS_QPOD	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20121017
3	Importing	STMT_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20121017
4	Importing	USER_NAME	Call by reference	☐	Type reference (TYPE)	SYBOBJOWNER		SYB: Object Owner (Index, Table, DB, Partition, ...)	20121017

Method HAS_ON_DISK_QUERY_PLAN on class CL_SYB_EXPLAIN_FACILITY has no exception.

Method IS_VALID_PLAN_HINT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PLAN_HINT	Call by reference	☐	Type reference (TYPE)	STRING			20120105
2	Returning	VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120105

Method IS_VALID_PLAN_HINT on class CL_SYB_EXPLAIN_FACILITY has no exception.

Method LOAD_DEF_OPTIMIZER_PARAMETERS Signature

Method LOAD_DEF_OPTIMIZER_PARAMETERS on class CL_SYB_EXPLAIN_FACILITY has no parameter.

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

Method PARSE_BIND_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	BIND_PARAMS	Value transfer	☐	Type reference (TYPE)	DBAXPLBINDPARAM_TAB		DBA Explain: Table of DBAXPLBINDPARAM	20120110
2	Exporting	CAPTION	Call by reference	☐	Type reference (TYPE)	STRING			20120110
3	Importing	NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20120110

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

Method PARSE_BIND_PARAM_SETS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BIND_PARAMS	Call by reference	☐	Type reference (TYPE)	DBAXPLBINDPARAM_TAB		DBA Explain: Table of DBAXPLBINDPARAM	20120111
2	Importing	PLANID	Call by reference	☐	Type reference (TYPE)	I			20120110
3	Importing	SIMPLE_PLAN	Call by reference	☐	Type reference (TYPE)	STRING			20120110

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

Method PERFORM_EXPLAIN_FROM_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DBNAME	Value transfer	☐	Type reference (TYPE)	SYBDBNAME		SYB: DB Name	20101117
2	Exporting	EXPLAIN_XML	Value transfer	☐	Type reference (TYPE)	STRING			20101110
3	Exporting	OPTGOAL	Value transfer	☐	Type reference (TYPE)	STRING			20110627
4	Exporting	OPTLEVEL	Value transfer	☐	Type reference (TYPE)	STRING			20110627
5	Importing	PLANID	Call by reference	☐	Type reference (TYPE)	I			20101110
6	Importing	SSQLID	Call by reference	☐	Type reference (TYPE)	I			20101110
7	Importing	STATEMENT	Call by reference	☐	Type reference (TYPE)	STRING			20101110
8	Exporting	USER_NAME	Value transfer	☐	Type reference (TYPE)	SYBOBJOWNER		SYB: Object Owner (Index, Table, DB, Partition, ...)	20110126

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

Method PERFORM_RUNTIME_EXPLAIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EXPLAIN_XML	Value transfer	☐	Type reference (TYPE)	STRING			20111109
2	Importing	STATEMENT	Call by reference	☐	Type reference (TYPE)	STRING			20111109

#	Exception	Resumable	Description	Created on
1	CX_DBA_ADBC	☐	DBA Cockpit: ADBC Errors	20111109
2	CX_DBA_CONVERSION	☐	Conversion Error	20111129

History

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