SAP ABAP Class CL_DB6_EXPLAIN_FACILITY (DB6 CCMS: EXPLAIN backend)
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_FACILITY DBA Cockpit: EXPLAIN Facility 20111111
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_DB6_EXPLAIN_DESIGN_ADVISOR DB6: Design Advisor Extension for EXPLAIN 20080619
3 Interface implementation (CLASS c. INTERFACES i_ref)  IF_DB6_EXPLAIN_OPTIMIZER_CFG DB6 Explain: Optimizer Configuration for EXPLAIN 20080306
4 Interface implementation (CLASS c. INTERFACES i_ref)  IF_DBA_EXPLAIN_FACILITY DBA EXPLAIN Model: EXPLAIN facility 20061222
5 Interface implementation (CLASS c. INTERFACES i_ref)  IF_DBA_EXPLAIN_OSS_DOWNLOAD DBA Explain: Availability of OSS Download Option 20090730
Properties
Class CL_DB6_EXPLAIN_FACILITY  
Short Description DB6 CCMS: EXPLAIN backend    
Super Class CL_DBA_EXPLAIN_FACILITY DBA Cockpit: EXPLAIN Facility 
Instantiability of a Class 0  Private 
Final    
General Data
Message Class    
Program status     
Category 0   
Package STU6   DB6: Performance-Monitor (UNIX/Windows) 
Created 20060619   SAP 
Last change 20140121   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 DB6CC Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
3 DB6SY Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_DB6_EXPLAIN_DESIGN_ADVISOR DB6: Design Advisor Extension for EXPLAIN 20080619
2 IF_DB6_EXPLAIN_OPTIMIZER_CFG DB6 Explain: Optimizer Configuration for EXPLAIN 20080306
3 IF_DBA_EXPLAIN_FACILITY DBA EXPLAIN Model: EXPLAIN facility 20061222
4 IF_DBA_EXPLAIN_OSS_DOWNLOAD DBA Explain: Availability of OSS Download Option 20090730
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 ADD_INFO_FLAG Instance attribute Private Type reference (TYPE) FLAG General Flag 20060622
2 ADVISE_EXPLAIN_TIME Instance attribute Private Type reference (TYPE) DB6PMADVIX-EXPLAIN_TIME DB6: Timestamp (Format: YYYYMMDDHHMMSS) 20080618
3 CO_DBO_TYPE_FUNCTION Constant Private Type reference (TYPE) STRING 'FUNCTION' 20100907
4 CO_DBO_TYPE_PROCEDURE Constant Private Type reference (TYPE) STRING 'PROCEDURE' 20100907
5 CO_DBO_TYPE_TABLE Constant Private Type reference (TYPE) STRING 'TABLE' 20100907
6 CO_DBO_TYPE_VIEW Constant Private Type reference (TYPE) STRING 'VIEW' 20100907
7 CO_EXECUTABLE_ID Constant Private Type reference (TYPE) STRING 'EXECUTABLE_ID' 20130305
8 CO_SECTION_EXPLAIN_ID Constant Private Type reference (TYPE) STRING 'SECTION_EXPLAIN' 20110127
9 DB_OBJECT_LIST Instance attribute Private Type reference (TYPE) TT_DB_OBJECT 20100907
10 EXPLAIN_DEFAULT_OPTLEVEL Constant Public Type reference (TYPE) I 5 20070102
11 EXPLAIN_DEFAULT_QUERY_DEGREE Constant Public Type reference (TYPE) I 1 20070102
12 EXPLAIN_SCHEMA Instance attribute Private Type reference (TYPE) DB6SCHEMA DB6: Schema Name 20060621
13 EXPLAIN_SNAPSHOT_MODE_NO Constant Public Type reference (TYPE) CHAR5 'NO' R/2 table 20061128
14 EXPLAIN_SNAPSHOT_MODE_YES Constant Public Type reference (TYPE) CHAR5 'YES' R/2 table 20061128
15 EXPLAIN_TABLESPACE Instance attribute Private Type reference (TYPE) STRING 20110123
16 SETUP_INSTANCE Static Attribute Private Object reference (TYPE REF TO) CL_DB6_EXPLAIN_FACILITY DB6 CCMS: EXPLAIN backend 20110123
17 VOLATILE_TABS_RESET Constant Private Type reference (TYPE) I 2 20080311
18 VOLATILE_TABS_SET Constant Private Type reference (TYPE) I 1 20080311
Methods
# Method Level Visibility Method type Description Created on
1 CAPTURE_DB_OBJECTS Instance method Private Method 20100907
2 CHECK_FACILITY Instance method Public Method 20100906
3 CONSTRUCTOR Instance method Private Constructor CONSTRUCTOR 20060619
4 COUNT Instance method Private Method 20060619
5 CREATE_EXPLAIN_FACILITY Instance method Private Method create EXPLAIN tables 20060620
6 DELETE_EXPLAIN_FUNCTION Instance method Private Method delete EXPLAIN function from database 20060619
7 DELETE_EXPLAIN_TABLE Instance method Private Method delete EXPLAIN table from database and remove DBDIFF entry 20060619
8 DELETE_OLD_GEN_REPORTS Instance method Private Method remove old reports generated for TEST EXECUTE 20060621
9 DROP_EXPLAIN_FACILITY Instance method Private Method drops EXPLAIN facility from given schema 20110123
10 DROP_FACILITY Instance method Public Method 20110123
11 EXTRACT_DBSL_COMMENTS Instance method Private Method extract DBSL comments from statement to EXPLAIN 20060622
12 FACILITY_UPTODATE Instance method Private Method return wether EXPLAIN facility exists in given schema 20060620
13 FREE_EXPLAIN_TABLES Instance method Private Method delete data of this explain from explain tables 20070214
14 GET_DEF_OPTIMIZER_PARAMETERS Instance method Private Method retrieve default optimizer parameters from DB engine 20060622
15 GET_EXECUTABLE_ID Static method Public Method 20130305
16 GET_EXPLAIN_TABLES Instance method Public Method 20110123
17 GET_LAST_EXPLAIN_TIME Instance method Private Method generate EXPLAIN execution ID 20070214
18 GET_OPT_LEVEL_FROM_EXPLAIN Instance method Private Method 20110127
19 GET_QUERY_DEGREE_FROM_EXPLAIN Instance method Private Method 20110127
20 GET_SECTION_EXPLAIN_ID Static method Public Method 20110127
21 GET_SETUP_INSTANCE Static method Public Method 20110123
22 GRANT_DB_OBJECTS Instance method Private Method 20100907
23 PERFORM_EXPLAIN Instance method Private Method calls DB2 EXPLAIN for given SQL statement 20060621
24 PERFORM_EXPLAIN_FROM_SECTION Instance method Private Method calls DB2 EXPLAIN for given SQL statement 20130305
25 PROVIDE_SCHEMA Instance method Private Method provide schema for all objects in DDL statement 20060620
26 SETUP_FACILITY Instance method Public Method 20060619
27 SET_SCHEMA Instance method Public Method 20110123
28 SET_TABLESPACE Instance method Public Method 20110123
29 SET_VOLATILE_FLAGS Instance method Private Method set or reset volatile flags 20070215
Events
Class CL_DB6_EXPLAIN_FACILITY has no event.
Types
Class CL_DB6_EXPLAIN_FACILITY has no local type.
Method Signatures

Method CAPTURE_DB_OBJECTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing DB_OBJECT_LIST Call by reference Type reference (TYPE) TT_DB_OBJECT 20100907
# Exception Resumable Description Created on
1 CX_DBA_ADBC DBA Cockpit: ADBC Errors 20100907

Method CHECK_FACILITY Signature

Method CHECK_FACILITY on class CL_DB6_EXPLAIN_FACILITY has no parameter.
# Exception Resumable Description Created on
1 CX_DB6_EXPLAIN DB6: EXPLAIN DDL Parser Errors 20100906

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing SETUP_INSTANCE_ONLY Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20111111
2 Importing SYS_REF Call by reference Object reference (TYPE REF TO) CL_DB6_SYS DB6: Remote System Administration 20060619
# Exception Resumable Description Created on
1 CX_DB6_EXPLAIN DB6: EXPLAIN DDL Parser Errors 20060620

Method COUNT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing COUNT Call by reference Type reference (TYPE) I 20060619
2 Importing DDL_OBJECTS Call by reference Type reference (TYPE) DB6CC_OBJECT_LIST 20060619
3 Importing SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA DB6: Schema Name 20060619
4 Changing SQL_STMT Call by reference Type reference (TYPE) STRING 20060619
5 Importing STMT_REF Call by reference Object reference (TYPE REF TO) CL_SQL_STATEMENT SQL statement 20060619
# Exception Resumable Description Created on
1 CX_SQL_EXCEPTION Ausnahmeklasse für SQL Fehler 20060619

Method CREATE_EXPLAIN_FACILITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXPL_DDL Call by reference Object reference (TYPE REF TO) CL_DB6_EXPLAIN_DDL DB6: EXPLAIN DDL 20060620
# Exception Resumable Description Created on
1 CX_DB6_EXPLAIN DB6: EXPLAIN DDL Parser Errors 20100920
2 CX_DBA_ADBC DBA Cockpit: ADBC-Fehler 20060620

Method DELETE_EXPLAIN_FUNCTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FUNCNAME Call by reference Type reference (TYPE) DB6TABNAML DB6: long table name 20060619
2 Importing SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA 20060620
3 Importing STMT_REF Call by reference Object reference (TYPE REF TO) CL_SQL_STATEMENT SQL statement 20060619
# Exception Resumable Description Created on
1 CX_DBA_ADBC DBA Cockpit: ADBC-Fehler 20060619

Method DELETE_EXPLAIN_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA 20060620
2 Importing STMT_REF Call by reference Object reference (TYPE REF TO) CL_SQL_STATEMENT SQL statement 20060619
3 Importing TABNAME Call by reference Type reference (TYPE) DB6TABNAML DB6: long table name 20060619
# Exception Resumable Description Created on
1 CX_DBA_ADBC DBA Cockpit: ADBC-Fehler 20060619

Method DELETE_OLD_GEN_REPORTS Signature

Method DELETE_OLD_GEN_REPORTS on class CL_DB6_EXPLAIN_FACILITY has no parameter.
# Exception Resumable Description Created on
1 CX_DB6_EXPLAIN DB6: EXPLAIN DDL Parser Errors 20060621

Method DROP_EXPLAIN_FACILITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXPL_DDL Call by reference Object reference (TYPE REF TO) CL_DB6_EXPLAIN_DDL DB6: EXPLAIN DDL 20110123
2 Importing SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA DB6: Schema Name 20110123
# Exception Resumable Description Created on
1 CX_DBA_ADBC DBA Cockpit: ADBC-Fehler 20110123

Method DROP_FACILITY Signature

Method DROP_FACILITY on class CL_DB6_EXPLAIN_FACILITY has no parameter.
# Exception Resumable Description Created on
1 CX_DB6_EXPLAIN DB6: EXPLAIN DDL Parser Errors 20110123

Method EXTRACT_DBSL_COMMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting REOPT Call by reference Type reference (TYPE) I 20060622
2 Exporting REPORTLINE Call by reference Type reference (TYPE) STRING 20060622
3 Exporting REPORTNAME Call by reference Type reference (TYPE) STRING 20060622
4 Changing STATEMENT Call by reference Type reference (TYPE) STRING 20060622
5 Exporting STMT_GUIDELINES Call by reference Type reference (TYPE) STRING 20080312
6 Exporting STMT_OPTLEVEL Call by reference Type reference (TYPE) I 20080311
7 Exporting STMT_QUERYDEG Call by reference Type reference (TYPE) I 20080311

Method EXTRACT_DBSL_COMMENTS on class CL_DB6_EXPLAIN_FACILITY has no exception.

Method FACILITY_UPTODATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXPL_DDL Call by reference Object reference (TYPE REF TO) CL_DB6_EXPLAIN_DDL DB6: EXPLAIN DDL 20060620
2 Returning UPTODATE Value transfer Type reference (TYPE) ABAP_BOOL 20060620
# Exception Resumable Description Created on
1 CX_DBA_ADBC DBA Cockpit: ADBC-Fehler 20060621

Method FREE_EXPLAIN_TABLES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXPLAIN_TIME Call by reference Type reference (TYPE) CHAR26 Character field length 26 20070214
# Exception Resumable Description Created on
1 CX_DB6_EXPLAIN DB6: EXPLAIN DDL Parser Errors 20070214
2 CX_DBA_ADBC DBA Cockpit: ADBC Errors 20070214

Method GET_DEF_OPTIMIZER_PARAMETERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting QUERYDEGREE Call by reference Type reference (TYPE) I 20060622
2 Exporting QUERYOPT Call by reference Type reference (TYPE) I 20060622
3 Importing SYS_REF Call by reference Object reference (TYPE REF TO) CL_DB6_SYS DB6: Remote System Administration 20060622
# Exception Resumable Description Created on
1 CX_DBA_ADBC DBA Cockpit: ADBC-Fehler 20060622

Method GET_EXECUTABLE_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXECUTABLE_ID Call by reference Type reference (TYPE) XSTRING DBA: ISO conform timestamp with ms precission 20130305
2 Returning ID Value transfer Type reference (TYPE) STRING 20130305
3 Importing MEMBER Call by reference Type reference (TYPE) I 20130305

Method GET_EXECUTABLE_ID on class CL_DB6_EXPLAIN_FACILITY has no exception.

Method GET_EXPLAIN_TABLES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning TABLES Value transfer Type reference (TYPE) DB6CC_OBJECT_LIST 20110123
# Exception Resumable Description Created on
1 CX_DB6_EXPLAIN DB6: EXPLAIN DDL Parser Errors 20110123

Method GET_LAST_EXPLAIN_TIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXPLAIN_SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA DB6: Schema Name 20070214
2 Returning EXPLAIN_TIME Value transfer Type reference (TYPE) CHAR26 20070214
3 Importing STMT_REF Call by reference Object reference (TYPE REF TO) CL_SQL_STATEMENT SQL statement 20070214
# Exception Resumable Description Created on
1 CX_DBA_ADBC DBA Cockpit: ADBC-Fehler 20070214

Method GET_OPT_LEVEL_FROM_EXPLAIN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXPLAIN_SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA DB6: Schema Name 20110127
2 Importing EXPLAIN_TIME Call by reference Type reference (TYPE) CHAR26 Character field length 26 20110127
3 Returning OPT_LEVEL Value transfer Type reference (TYPE) I 20110127

Method GET_OPT_LEVEL_FROM_EXPLAIN on class CL_DB6_EXPLAIN_FACILITY has no exception.

Method GET_QUERY_DEGREE_FROM_EXPLAIN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXPLAIN_SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA DB6: Schema Name 20110127
2 Importing EXPLAIN_TIME Call by reference Type reference (TYPE) CHAR26 Character field length 26 20110127
3 Returning QUERY_DEGREE Value transfer Type reference (TYPE) I 20110127

Method GET_QUERY_DEGREE_FROM_EXPLAIN on class CL_DB6_EXPLAIN_FACILITY has no exception.

Method GET_SECTION_EXPLAIN_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXPLAIN_TIMESTAMP Call by reference Type reference (TYPE) DB6DATETIM DBA: ISO conform timestamp with ms precission 20110127
2 Returning ID Value transfer Type reference (TYPE) STRING 20110127

Method GET_SECTION_EXPLAIN_ID on class CL_DB6_EXPLAIN_FACILITY has no exception.

Method GET_SETUP_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning FACILITY Value transfer Object reference (TYPE REF TO) CL_DB6_EXPLAIN_FACILITY DBA EXPLAIN Model: EXPLAIN facility 20110123
2 Importing SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA DB6: Schema Name 20110123
3 Importing SYS_REF Call by reference Object reference (TYPE REF TO) CL_DB6_SYS DB6: Remote System Administration 20110123
4 Importing TABLESPACE Call by reference Type reference (TYPE) DB6TSPNAME DB6: Tablespace Name 20110123
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20110123

Method GRANT_DB_OBJECTS Signature

Method GRANT_DB_OBJECTS on class CL_DB6_EXPLAIN_FACILITY has no parameter.
# Exception Resumable Description Created on
1 CX_DB6_EXPLAIN DB6: EXPLAIN DDL Parser Errors 20100907
2 CX_DBA_ADBC DBA Cockpit: ADBC Errors 20100907

Method PERFORM_EXPLAIN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EXPLAIN_TIME Value transfer Type reference (TYPE) CHAR26 20070214
2 Importing OPTLEVEL Call by reference Type reference (TYPE) I 20070214
3 Importing OPT_GUIDELINES Call by reference Type reference (TYPE) STRING 20080312
4 Importing QUERYDEGREE Call by reference Type reference (TYPE) I 20070214
5 Importing REOPT Call by reference Type reference (TYPE) I 20060621
6 Importing SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA DB6: Schema Name 20070214
7 Importing STATEMENT Call by reference Type reference (TYPE) STRING 20060621
# Exception Resumable Description Created on
1 CX_DB6_EXPLAIN DB6: EXPLAIN DDL Parser Errors 20071002
2 CX_DBA_ADBC DBA Cockpit: ADBC-Fehler 20060621

Method PERFORM_EXPLAIN_FROM_SECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXECUTABLE_ID Call by reference Type reference (TYPE) XSTRING 20130305
2 Returning EXPLAIN_TIME Value transfer Type reference (TYPE) CHAR26 20130305
3 Importing MEMBER Call by reference Type reference (TYPE) I -1 20130305
4 Importing SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA DB6: Schema Name 20130305
5 Importing STATEMENT Call by reference Type reference (TYPE) STRING 20130305
# Exception Resumable Description Created on
1 CX_DB6_EXPLAIN DB6: EXPLAIN DDL Parser Errors 20130305
2 CX_DBA_ADBC DBA Cockpit: ADBC-Fehler 20130305

Method PROVIDE_SCHEMA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DDL_OBJECTS Call by reference Type reference (TYPE) DB6CC_OBJECT_LIST 20060620
2 Importing SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA DB6: Schema Name 20060620
3 Changing SQL_STMT Call by reference Type reference (TYPE) STRING 20060620

Method PROVIDE_SCHEMA on class CL_DB6_EXPLAIN_FACILITY has no exception.

Method SETUP_FACILITY Signature

Method SETUP_FACILITY on class CL_DB6_EXPLAIN_FACILITY has no parameter.
# Exception Resumable Description Created on
1 CX_DB6_EXPLAIN DB6: EXPLAIN DDL Parser Errors 20060620

Method SET_SCHEMA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing SCHEMA Call by reference Type reference (TYPE) DB6SCHEMA 20110123

Method SET_SCHEMA on class CL_DB6_EXPLAIN_FACILITY has no exception.

Method SET_TABLESPACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing TABLESPACE Call by reference Type reference (TYPE) DB6TSPNAME DB6: Tablespace Name 20110123

Method SET_TABLESPACE on class CL_DB6_EXPLAIN_FACILITY has no exception.

Method SET_VOLATILE_FLAGS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ACTION Call by reference Type reference (TYPE) I 1=set; 2=reset 20070215
2 Importing SYS_REF Call by reference Object reference (TYPE REF TO) CL_DB6_SYS DB6: Remote System Administration 20070215
3 Changing VOLATILE_TABLES Call by reference Type reference (TYPE) DB6XPLVOLA_TAB DB6: table of VOLATILE tables 20070215
# Exception Resumable Description Created on
1 CX_DBA_ADBC DBA Cockpit: ADBC Errors 20070215
History
Last changed by/on SAP  20140121 
SAP Release Created in 710