Skip to content

/AWS1/IF_GLU=>GETENTITYRECORDS()

About GetEntityRecords

This API is used to query preview data from a given connection type or from a native Amazon S3 based Glue Data Catalog.

Returns records as an array of JSON blobs. Each record is formatted using Jackson JsonNode based on the field type defined by the DescribeEntity API.

Spark connectors generate schemas according to the same data type mapping as in the DescribeEntity API. Spark connectors convert data to the appropriate data types matching the schema when returning rows.

Method Signature

METHODS /AWS1/IF_GLU~GETENTITYRECORDS
  IMPORTING
    !IV_CONNECTIONNAME TYPE /AWS1/GLUNAMESTRING OPTIONAL
    !IV_CATALOGID TYPE /AWS1/GLUCATALOGIDSTRING OPTIONAL
    !IV_ENTITYNAME TYPE /AWS1/GLUENTITYNAME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/GLUNEXTTOKEN OPTIONAL
    !IV_DATASTOREAPIVERSION TYPE /AWS1/GLUAPIVERSION OPTIONAL
    !IT_CONNECTIONOPTIONS TYPE /AWS1/CL_GLUCONNOPTIONS_W=>TT_CONNECTIONOPTIONS OPTIONAL
    !IV_FILTERPREDICATE TYPE /AWS1/GLUFILTERPREDICATE OPTIONAL
    !IV_LIMIT TYPE /AWS1/GLULIMIT OPTIONAL
    !IV_ORDERBY TYPE /AWS1/GLUSTRING OPTIONAL
    !IT_SELECTEDFIELDS TYPE /AWS1/CL_GLUSELECTEDFIELDS_W=>TT_SELECTEDFIELDS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_glugetentityrecsrsp
  RAISING
    /AWS1/CX_GLUACCESSDENIEDEX
    /AWS1/CX_GLUENTITYNOTFOUNDEX
    /AWS1/CX_GLUFEDR8NSOURCEEX
    /AWS1/CX_GLUGLUEENCEXCEPTION
    /AWS1/CX_GLUINVALIDINPUTEX
    /AWS1/CX_GLUOPERATIONTIMEOUTEX
    /AWS1/CX_GLUVALIDATIONEX
    /AWS1/CX_GLUCLIENTEXC
    /AWS1/CX_GLUSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_entityname TYPE /AWS1/GLUENTITYNAME /AWS1/GLUENTITYNAME

Name of the entity that we want to query the preview data from the given connection type.

iv_limit TYPE /AWS1/GLULIMIT /AWS1/GLULIMIT

Limits the number of records fetched with the request.

Optional arguments:

iv_connectionname TYPE /AWS1/GLUNAMESTRING /AWS1/GLUNAMESTRING

The name of the connection that contains the connection type credentials.

iv_catalogid TYPE /AWS1/GLUCATALOGIDSTRING /AWS1/GLUCATALOGIDSTRING

The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.

iv_nexttoken TYPE /AWS1/GLUNEXTTOKEN /AWS1/GLUNEXTTOKEN

A continuation token, included if this is a continuation call.

iv_datastoreapiversion TYPE /AWS1/GLUAPIVERSION /AWS1/GLUAPIVERSION

The API version of the SaaS connector.

it_connectionoptions TYPE /AWS1/CL_GLUCONNOPTIONS_W=>TT_CONNECTIONOPTIONS TT_CONNECTIONOPTIONS

Connector options that are required to query the data.

iv_filterpredicate TYPE /AWS1/GLUFILTERPREDICATE /AWS1/GLUFILTERPREDICATE

A filter predicate that you can apply in the query request.

iv_orderby TYPE /AWS1/GLUSTRING /AWS1/GLUSTRING

A parameter that orders the response preview data.

it_selectedfields TYPE /AWS1/CL_GLUSELECTEDFIELDS_W=>TT_SELECTEDFIELDS TT_SELECTEDFIELDS

List of fields that we want to fetch as part of preview data.

RETURNING

oo_output TYPE REF TO /aws1/cl_glugetentityrecsrsp /AWS1/CL_GLUGETENTITYRECSRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getentityrecords(
  it_connectionoptions = VALUE /aws1/cl_gluconnoptions_w=>tt_connectionoptions(
    (
      VALUE /aws1/cl_gluconnoptions_w=>ts_connectionoptions_maprow(
        value = new /aws1/cl_gluconnoptions_w( |string| )
        key = |string|
      )
    )
  )
  it_selectedfields = VALUE /aws1/cl_gluselectedfields_w=>tt_selectedfields(
    ( new /aws1/cl_gluselectedfields_w( |string| ) )
  )
  iv_catalogid = |string|
  iv_connectionname = |string|
  iv_datastoreapiversion = |string|
  iv_entityname = |string|
  iv_filterpredicate = |string|
  iv_limit = 123
  iv_nexttoken = |string|
  iv_orderby = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_records( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.