API for Amazon DocumentDB with MongoDB compatibility¶
ABAP Package | /AWS1/API_DOD_IMPL |
---|---|
ABAP SDK "TLA" | DOD |
ABAP Interface | /AWS1/IF_DOD |
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 Amazon DocumentDB with MongoDB compatibility is DOD
.
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 DocDB 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¶
Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.
Using the SDK¶
In your code, create a client using the SDK module for Amazon DocumentDB with MongoDB compatibility, which is created with
factory method /AWS1/CL_DOD_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_dod) = /aws1/cl_dod_factory=>create( go_session ).
Your variable go_dod
is an instance of /AWS1/IF_DOD
,
and all of the operations
in the Amazon DocumentDB with MongoDB compatibility service are accessed by calling methods in /AWS1/IF_DOD
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon DocumentDB with MongoDB compatibility, see the Operation List.
Factory Method¶
/AWS1/CL_DOD_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_DOD
.
IMPORTING¶
Optional arguments:¶
IV_PROTOCOL
TYPE /AWS1/RT_PROTOCOL
/AWS1/RT_PROTOCOL
¶
IO_SESSION
TYPE REF TO /AWS1/CL_RT_SESSION_BASE
/AWS1/CL_RT_SESSION_BASE
¶
IV_REGION
TYPE /AWS1/RT_REGION_ID
/AWS1/RT_REGION_ID
¶
IV_CUSTOM_ENDPOINT
TYPE /AWS1/RT_ENDPOINT
/AWS1/RT_ENDPOINT
¶
RETURNING¶
OO_CLIENT
TYPE REF TO /AWS1/IF_DOD
/AWS1/IF_DOD
¶
/AWS1/IF_DOD
represents the ABAP client for the DocDB service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_dod)->get_config( ).
lo_config
is a variable of type /AWS1/CL_DOD_CONFIG
. See the documentation for /AWS1/CL_DOD_CONFIG
for
details on the settings that can be configured.
Waiters¶
Waiters for Implementation can be accessed via get_waiter()
method followed by the waiter method to be called.
Details about the waiter methods available for service Implementation can be found in interface /AWS1/IF_DOD_WAITER
.
Paginators¶
Paginators for Amazon DocumentDB with MongoDB compatibility can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_DOD_PAGINATOR
. 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 Amazon DocumentDB with MongoDB compatibility can be found in interface /AWS1/IF_DOD_PAGINATOR
.