Analyze AMDP Performance

0 %

Analyze AMDP Performance

Details

// Explore More Tutorials

Analyze AMDP Performance

Julie Plummer

04/03/2019

Beginner

45 min.

Analyze the runtime performance of AMDPs and the executed SQL statements using the AMDP Profiler in ABAP Development Tools (ADT).

You will learn

How to create an ABAP class containing an ABAP Managed Database Procedure (AMDP)
How to run the ABAP Profiler on this class

Throughout this tutorial, objects name include the suffix XXX. Always replace this with your group number or initials.

You should be familiar with ABAP Managed Database Procedures (AMDP). Briefly, AMDP allows you to optimize your ABAP code (for ABAP on SAP HANA) by calling HANA database procedures from a global ABAP class.
For more details, see:

Step 1: Install the Flight Reference Scenario using abapGit

Create the package /DMO/FLIGHT as a sub-package under the package /DMO/SAP (keep the default values). IMPORTANT: Make sure that the software component is also /DMO/SAP.
Open the abapGit view by choosing Window > Show View > Other… > abapGit Repositories. Make sure you have the correct ABAP Cloud Project marked (See the little headline in the abapGit view for the current project.)
Clone a repository by choosing + and enter the repository URL: https://github.com/SAP/abap-platform-refscen-flight.git.
On the next page choose the master branch and provide the package /DMO/FLIGHT.
Create or assign a transport request and choose Finish. This starts the cloning of the repository, which might take a few minutes
Once the cloning has finished, refresh your project tree.
Finally, generate some sample data by running the ABAP class /DMO/CL_FLIGHT_DATA_GENERATOR by choosing Run as Console Application (F9).

Done

Log on to answer question

Step 2: Create an ABAP package in /DMO/SAP

One of the restrictions of the ABAP Environment on SAP Cloud Platform is that you can only use other objects if they are released objects (whitelisted) or in the same software component.
Since you will be using objects in the /DMO/SAP software component, you need to create your package in /DMO/SAP.

Select your project. From the context menu, choose New > ABAP Package.
Enter a name and description for your package, then choose Next.
IMPORTANT: Make sure that you prefix the name with /DMO/, for example: Name = /DMO/AMDP_XXX (replacing XXX with your group number or initials)
Enter the software component /DMO/SAP. You can leave the other fields blank.
Create or assign a transport request and choose Finish.

Done

Log on to answer question

Step 3: Create an ABAP class

Again, from the context menu of your package, choose New > ABAP Class.
Enter a name and description, then choose Next. Make sure that you prefix the class name with /DMO/, for example:
- Name: /DMO/ZCL_AMDP_DEMO_XXX
- Description: AMDP Demo w Flight ref
Assign the transport request and choose Finish.

Done

Log on to answer question

Step 4: Add two interfaces

View Full Instructions

Add two interfaces by adding this code to the public section.

if_amdp_marker_hdb defines the class as an AMDP class, allowing you to implement AMDP methods - that is, ABAP methods that call a SAP HANA database procedure from within a global ABAP class.
if_oo_adt_classrun allows you to output the results to the ABAP Console.

INTERFACES: if_amdp_marker_hdb,
if_oo_adt_classrun.

Done

Log on to answer question

Step 5: Create structures and table types

View Full Instructions

Add these structures and types to the public section, just after the interface definitions.
Note the data elements that you imported earlier.

TYPES:
  BEGIN OF ty_result_line,
    airline           TYPE /dmo/carrier_name,
    flight_connection TYPE /dmo/connection_id,
    old_price         TYPE /dmo/flight_price,
    old_currency      TYPE /dmo/currency_code,
    new_price         TYPE /dmo/flight_price,
    new_currency      TYPE /dmo/currency_code,
  END OF ty_result_line,

  BEGIN OF ty_flights_line,
    airline           TYPE /dmo/carrier_name,
    flight_connection TYPE /dmo/connection_id,
    price             TYPE /dmo/flight_price,
    currency          TYPE /dmo/currency_code,
  END OF ty_flights_line,

  ty_result_table  TYPE STANDARD TABLE OF ty_result_line WITH EMPTY KEY,
  ty_flights_table TYPE STANDARD TABLE OF ty_flights_line WITH EMPTY KEY,
  ty_flights       TYPE STANDARD TABLE OF /dmo/flight.

Done

Log on to answer question

Step 6: Add method definitions

View Full Instructions

Add these two method definitions to your code. Ignore the errors for now.


METHODS:
  get_flights
    EXPORTING
              VALUE(result) TYPE ty_result_table
    RAISING   cx_amdp_execution_error,

  convert_currency
    IMPORTING
              VALUE(flights) TYPE ty_flights_table
    EXPORTING
              VALUE(result)  TYPE ty_result_table
    RAISING   cx_amdp_execution_error.

Both of these are AMDP methods.

Done

Log on to answer question

Step 7: Implement get_flights

View Full Instructions

In the class definition, select any one of the methods and choose Add 3 unimplemented methods. All three (empty) implementations will appear in the class implementation.
Add the following to the method get_flights. Both this and convert_currency are SQLScript.

For more information on SAP HANA SQLScript, see SAP HANA SQLScript Reference
```
METHOD GET_FLIGHTS by database procedure
  for hdb
  language sqlscript
  options read-only
  using
    /dmo/flight
    /dmo/carrier
    /dmo/zcl_amdp_demo_xxx=>convert_currency.
```
You must specify all ABAP tables, views, and AMDP procedures in the USING clause.
For more details on these clauses, see ABAP Keyword Documentation: Method - By Database Procedure, Function

Add the SELECT statement. Ignore the warning for now.

flights = select distinct

  from "/DMO/FLIGHT"  as f
  inner join "/DMO/CARRIER" as c
    on f.carrier_id = c.carrier_id;

Add the fields. You can do this using Auto-complete (Ctrl+1), to make sure you are using the correct field names.


flights = select distinct
  c.name as airline,
  f.connection_id as flight_connection,
  f.price    as price,
  f.currency_code as currency
  from "/DMO/FLIGHT"  as f
  inner join "/DMO/CARRIER" as c
    on f.carrier_id = c.carrier_id;

Finally, call the other AMDP method, convert_currency. Your method should look like this:


METHOD get_flights BY DATABASE PROCEDURE
  FOR HDB
  LANGUAGE SQLSCRIPT
  OPTIONS READ-ONLY
  USING
    /dmo/flight
    /dmo/carrier
    /dmo/zcl_amdp_demo_xxx=>convert_currency.

  flights = select distinct
    c.name as airline,
    f.connection_id as flight_connection,
    f.price    as price,
    f.currency_code as currency
    from "/DMO/FLIGHT"  as f
    inner join "/DMO/CARRIER" as c
      on f.carrier_id = c.carrier_id;

  call "/DMO/ZCL_AMDP_DEMO_XXX=>CONVERT_CURRENCY"( :flights, result );

ENDMETHOD.

Done

Log on to answer question

Step 8: Implement the method convert_currency

View Full Instructions

Similarly, implement the convert_currency method.


METHOD convert_currency BY DATABASE PROCEDURE
  FOR HDB
  LANGUAGE SQLSCRIPT
  OPTIONS READ-ONLY.

  declare today date;
  declare new_currency nvarchar(3);

  select current_date into today from dummy;
  new_currency := 'EUR';

  result = select distinct
    airline,
    flight_connection,
    price    as old_price,
    currency as old_currency,
    convert_currency(
      "AMOUNT"          => price,
      "SOURCE_UNIT"     => currency,
      "TARGET_UNIT"     => :new_currency,
      "REFERENCE_DATE"  => :today,
      "CLIENT"          => '100',
      "ERROR_HANDLING"  => 'set to null',
      "SCHEMA"          => current_schema
    ) as new_price,
    :new_currency as new_currency
    from :flights;

ENDMETHOD.

Done

Log on to answer question

Step 9: Implement the method `main` of the interface if_oo_adt_classrun

View Full Instructions

Finally, implement the main method of the interface if_oo_adt_classrun. This will allow you to output your results to the ABAP Console.

Call the method get_flights from the current instance of the class:
```
me->get_flights(
  IMPORTING
    result = DATA(lt_result) ).
```
Output the result to the console:

out->write( lt_result ).

Wrap this in an exception:

TRY.

CATCH cx_amdp_execution_error INTO DATA(lx_amdp).
  out->write( lx_amdp->get_longtext( ) ).

Your method should now look like this:

METHOD if_oo_adt_classrun~main.

  TRY.
      me->get_flights(
        IMPORTING
          result = DATA(lt_result) ).

    CATCH cx_amdp_execution_error INTO DATA(lx_amdp).
      out->write( lx_amdp->get_longtext( ) ).
  ENDTRY.

  out->write( lt_result ).

ENDMETHOD.

Done

Log on to answer question

Step 10: Check your code

View Full Instructions

Your code should look like this.

CLASS /dmo/zcl_amdp_demo_xxx DEFINITION
  PUBLIC
  FINAL
  CREATE PUBLIC .

  PUBLIC SECTION.
    INTERFACES: if_amdp_marker_hdb,
      if_oo_adt_classrun.

    TYPES:
      BEGIN OF ty_result_line,
        airline           TYPE /dmo/carrier_name,
        flight_connection TYPE /dmo/connection_id,
        old_price         TYPE /dmo/flight_price,
        old_currency      TYPE /dmo/currency_code,
        new_price         TYPE /dmo/flight_price,
        new_currency      TYPE /dmo/currency_code,
      END OF ty_result_line,

      BEGIN OF ty_flights_line,
        airline           TYPE /dmo/carrier_name,
        flight_connection TYPE /dmo/connection_id,
        price             TYPE /dmo/flight_price,
        currency          TYPE /dmo/currency_code,
      END OF ty_flights_line,

      ty_result_table  TYPE STANDARD TABLE OF ty_result_line WITH EMPTY KEY,
      ty_flights_table TYPE STANDARD TABLE OF ty_flights_line WITH EMPTY KEY,
      ty_flights       TYPE STANDARD TABLE OF /dmo/flight.

    METHODS:
      get_flights
        EXPORTING
                  VALUE(result) TYPE ty_result_table
        RAISING   cx_amdp_execution_error,

      convert_currency
        IMPORTING
                  VALUE(flights) TYPE ty_flights_table
        EXPORTING
                  VALUE(result)  TYPE ty_result_table
        RAISING   cx_amdp_execution_error.

  PROTECTED SECTION.
  PRIVATE SECTION.
ENDCLASS.


CLASS /dmo/zcl_amdp_demo_xxx IMPLEMENTATION.

  METHOD get_flights BY DATABASE PROCEDURE
    FOR HDB
    LANGUAGE SQLSCRIPT
    OPTIONS READ-ONLY
    USING
      /dmo/flight
      /dmo/carrier
      /dmo/zcl_amdp_demo_xxx=>convert_currency.

    flights = select distinct
      c.name as airline,
      f.connection_id as flight_connection,
      f.price    as price,
      f.currency_code as currency
      from "/DMO/FLIGHT"  as f
      inner join "/DMO/CARRIER" as c
        on f.carrier_id = c.carrier_id;

    call "/DMO/ZCL_AMDP_DEMO_XXX=>CONVERT_CURRENCY"( :flights, result );

  ENDMETHOD.


  METHOD convert_currency BY DATABASE PROCEDURE
    FOR HDB
    LANGUAGE SQLSCRIPT
    OPTIONS READ-ONLY.

    declare today date;
    declare new_currency nvarchar(3);

    select current_date into today from dummy;
    new_currency := 'EUR';

    result = select distinct
      airline,
      flight_connection,
      price    as old_price,
      currency as old_currency,
      convert_currency(
        "AMOUNT"          => price,
        "SOURCE_UNIT"     => currency,
        "TARGET_UNIT"     => :new_currency,
        "REFERENCE_DATE"  => :today,
        "CLIENT"          => '100',
        "ERROR_HANDLING"  => 'set to null',
        "SCHEMA"          => current_schema
      ) as new_price,
      :new_currency as new_currency
      from :flights;

  ENDMETHOD.


  METHOD if_oo_adt_classrun~main.

    TRY.
        me->get_flights(
          IMPORTING
            result = DATA(lt_result) ).

      CATCH cx_amdp_execution_error INTO DATA(lx_amdp).
        out->write( lx_amdp->get_longtext( ) ).
    ENDTRY.

    out->write( lt_result ).

  ENDMETHOD.
ENDCLASS.

Done

Log on to answer question

Step 11: Save, activate, and test your code

Save and activate your code by choosing Ctrl+S, Ctrl+3.
Optional: Test your class by running it the ABAP Console (**F9**).

Your output should look like this:

Image depicting step11-console

Done

Log on to answer question

Step 12: Create an ABAP trace request

Switch to the ABAP Profiling perspective.
Open the ABAP Trace Requests view.
Choose your project and choose Create Trace Request… from the toolbar.
Choose the following options, then choose Next:
- Which requests: Any
- Object type: Any
- Server: All servers
- Maximum trace files… : 3
- Title: Any for AMDP Demo
On the next screen, leave the other defaults, choose Enable AMDP trace, then choose Finish.

Done

Log on to answer question

Step 13: Examine the AMDP Profiling Result

Refresh your trace request. Once it is finished, return to the ABAP Traces View.
Open the Profiling Overview by choosing (double-clicking) your trace.
Choose the ABAP Database Managed Procedures tab from the bottom.
The ABAP Managed Database Procedures overview displays the result of the AMDP profiling analysis in a table.

To get more details about the statement which has been executed at ABAP runtime, view the table and expand the relevant procedure nodes.
Optional: To navigate to the relevant position within your ABAP source code, double-click the corresponding statement.
The development object is then opened and the cursor is positioned at the relevant position.

You can now analyze the results of your AMDP profiling. For more details, see:
- AMDP Profiling
- Understanding AMDP Profiling Results

Done

Log on to answer question

Step 14: Test yourself

Define an AMDP method get_sales_orders (based on the AMDP method get_flights).
Specify the options:

Database = SAP HANA
Language = SQLScript
Options = read-only
Objects used = snwd_so, snwd_so_i, and the method read_sales_orders of the class zcl_demo.

Do not indent your code.

Enter your code in the box below and choose Submit Answer.

Next Steps

Prerequisites

You have a sub-account with the entitlement SAP Cloud Platform, ABAP environment, release 1902 or higher. For more details, see Getting Started with a Customer Account: Workflow in the ABAP Environment.
You have installed ABAP Development Tools 3.0.
You have created an ABAP Cloud Project pointing to this ABAP environment. For more details, see Connect to the ABAP System.
You have installed the abapGit plug-in for Eclipse from abapGit.
You have fulfilled the prerequisites for ABAP Database Managed Procedures (AMDP). For more details, see SAP Note 1899222.

Navigate tutorial steps

Step 1: Install the Flight Reference Scenario using abapGit
Step 2: Create an ABAP package in /DMO/SAP
Step 3: Create an ABAP class
Step 4: Add two interfaces
Step 5: Create structures and table types
Step 6: Add method definitions
Step 7: Implement get_flights
Step 8: Implement the method convert_currency
Step 9: Implement the method `main` of the interface if_oo_adt_classrun
Step 10: Check your code
Step 11: Save, activate, and test your code
Step 12: Create an ABAP trace request
Step 13: Examine the AMDP Profiling Result
Step 14: Test yourself
Back to Top

QR Code

Analyze AMDP Performance

Analyze AMDP Performance

You will learn

Next Steps

Prerequisites

Call me now