Skip to content

API for odb

ABAP Package /AWS1/API_ODB_IMPL
ABAP SDK "TLA" ODB
ABAP Interface /AWS1/IF_ODB

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for odb is ODB. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the odb module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service

Oracle Database@Amazon Web Services is an offering that enables you to access Oracle Exadata infrastructure managed by Oracle Cloud Infrastructure (OCI) inside Amazon Web Services data centers. You can migrate your Oracle Exadata workloads, establish low-latency connectivity with applications running on Amazon Web Services, and integrate with Amazon Web Services services. For example, you can run application servers in a virtual private cloud (VPC) and access an Oracle Exadata system running in Oracle Database@Amazon Web Services. You can get started with Oracle Database@Amazon Web Services by using the familiar Amazon Web Services Management Console, APIs, or CLI.

This interface reference for Oracle Database@Amazon Web Services contains documentation for a programming or command line interface that you can use to manage Oracle Database@Amazon Web Services. Oracle Database@Amazon Web Services is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. The reference structure is as follows.

In this preview release documentation, the links in the "See Also" sections do not work.

Oracle Database@Amazon Web Services API Reference

  • For the alphabetical list of API actions, see .

  • For the alphabetical list of data types, see .

  • For a list of common parameters, see CommonParameters.

  • For descriptions of the error codes, see CommonErrors.

Using the SDK

In your code, create a client using the SDK module for odb, which is created with factory method /AWS1/CL_ODB_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_odb)       = /aws1/cl_odb_factory=>create( go_session ).

Your variable go_odb is an instance of /AWS1/IF_ODB, and all of the operations in the odb service are accessed by calling methods in /AWS1/IF_ODB.

API Operations

For an overview of ABAP method calls corresponding to API operations in odb, see the Operation List.

Factory Method

/AWS1/CL_ODB_FACTORY=>create( )

Creates an object of type /AWS1/IF_ODB.

IMPORTING

Optional arguments:

iv_protocol TYPE /aws1/rt_protocol /AWS1/RT_PROTOCOL

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

io_session TYPE REF TO /aws1/cl_rt_session_base /AWS1/CL_RT_SESSION_BASE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

iv_region TYPE /aws1/rt_region_id /AWS1/RT_REGION_ID

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

iv_custom_endpoint TYPE /aws1/rt_endpoint /AWS1/RT_ENDPOINT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

RETURNING

oo_client TYPE REF TO /aws1/if_odb /AWS1/IF_ODB

/AWS1/IF_ODB represents the ABAP client for the odb service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically

DATA(lo_config) = DATA(go_odb)->get_config( ).

lo_config is a variable of type /AWS1/CL_ODB_CONFIG. See the documentation for /AWS1/CL_ODB_CONFIG for details on the settings that can be configured.

Paginators

Paginators for odb can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_ODB_PAGINATOR`](./_AWS1_IF_ODB_PAGINATOR.md). The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using `has_next()` and `get_next()` methods.

Details about the paginator methods available for service odb can be found in interface [`/AWS1/IF_ODB_PAGINATOR`](./_AWS1_IF_ODB_PAGINATOR.md).