SAP DB6_EXPLAIN Function Module for DB6: Explain - Perform Explain









DB6_EXPLAIN is a standard db6 explain SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for DB6: Explain - Perform Explain processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for db6 explain FM, simply by entering the name DB6_EXPLAIN into the relevant SAP transaction such as SE37 or SE38.

Function Group: DB6X
Program Name: SAPLDB6X
Main Program: SAPLDB6X
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function DB6_EXPLAIN pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'DB6_EXPLAIN'"DB6: Explain - Perform Explain
EXPORTING
INPUT_STATEMENT = "stmt_text: SQL Statement to be explained
* NO_DISPLAY = ' ' "flag for output of access plan in ascii or tree format
* ADVISE_EXPLAIN_TIME = "explain time of index advisor
* SYS_DATA = "DB6: System Registration Table

EXCEPTIONS
ADBC_ERROR = 1 SYSTEM_ERROR = 2
.



IMPORTING Parameters details for DB6_EXPLAIN

INPUT_STATEMENT - stmt_text: SQL Statement to be explained

Data type: STRING
Optional: No
Call by Reference: No ( called with pass by value option)

NO_DISPLAY - flag for output of access plan in ascii or tree format

Data type: DB6PMHCDM-OBJECTTYPE
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

ADVISE_EXPLAIN_TIME - explain time of index advisor

Data type: DB6PMADVIX-EXPLAIN_TIME
Optional: Yes
Call by Reference: No ( called with pass by value option)

SYS_DATA - DB6: System Registration Table

Data type: DB6NAVSYST
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXCEPTIONS details

ADBC_ERROR -

Data type:
Optional: No
Call by Reference: Yes

SYSTEM_ERROR -

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for DB6_EXPLAIN Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.

DATA:
lv_adbc_error  TYPE STRING, "   
lv_input_statement  TYPE STRING, "   
lv_no_display  TYPE DB6PMHCDM-OBJECTTYPE, "   SPACE
lv_system_error  TYPE DB6PMHCDM, "   
lv_advise_explain_time  TYPE DB6PMADVIX-EXPLAIN_TIME, "   
lv_sys_data  TYPE DB6NAVSYST. "   

  CALL FUNCTION 'DB6_EXPLAIN'  "DB6: Explain - Perform Explain
    EXPORTING
         INPUT_STATEMENT = lv_input_statement
         NO_DISPLAY = lv_no_display
         ADVISE_EXPLAIN_TIME = lv_advise_explain_time
         SYS_DATA = lv_sys_data
    EXCEPTIONS
        ADBC_ERROR = 1
        SYSTEM_ERROR = 2
. " DB6_EXPLAIN




ABAP code using 7.40 inline data declarations to call FM DB6_EXPLAIN

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

 
 
"SELECT single OBJECTTYPE FROM DB6PMHCDM INTO @DATA(ld_no_display).
DATA(ld_no_display) = ' '.
 
 
"SELECT single EXPLAIN_TIME FROM DB6PMADVIX INTO @DATA(ld_advise_explain_time).
 
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!