/AWS1/IF_DYN=>SCAN()¶
About Scan¶
The Scan operation returns one or more items and item attributes by
accessing every item in a table or a secondary index. To have DynamoDB return fewer
items, you can provide a FilterExpression operation.
If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the
scan completes and results are returned to the user. The LastEvaluatedKey
value is also returned and the requestor can use the LastEvaluatedKey to
continue the scan in a subsequent operation. Each scan response also includes number of
items that were scanned (ScannedCount) as part of the request. If using a
FilterExpression, a scan result can result in no items meeting the
criteria and the Count will result in zero. If you did not use a
FilterExpression in the scan request, then Count is the
same as ScannedCount.
Count and ScannedCount only return the count of items
specific to a single scan request and, unless the table is less than 1MB, do not
represent the total number of items in the table.
A single Scan operation first reads up to the maximum number of items set
(if using the Limit parameter) or a maximum of 1 MB of data and then
applies any filtering to the results if a FilterExpression is provided. If
LastEvaluatedKey is present in the response, pagination is required to
complete the full table scan. For more information, see Paginating the
Results in the Amazon DynamoDB Developer Guide.
Scan operations proceed sequentially; however, for faster performance on
a large table or secondary index, applications can request a parallel Scan
operation by providing the Segment and TotalSegments
parameters. For more information, see Parallel
Scan in the Amazon DynamoDB Developer Guide.
By default, a Scan uses eventually consistent reads when accessing the
items in a table. Therefore, the results from an eventually consistent Scan
may not include the latest item changes at the time the scan iterates through each item
in the table. If you require a strongly consistent read of each item as the scan
iterates through the items in the table, you can set the ConsistentRead
parameter to true. Strong consistency only relates to the consistency of the read at the
item level.
DynamoDB does not provide snapshot isolation for a scan operation when the
ConsistentRead parameter is set to true. Thus, a DynamoDB scan
operation does not guarantee that all reads in a scan see a consistent snapshot of
the table when the scan operation was requested.
Method Signature¶
METHODS /AWS1/IF_DYN~SCAN
IMPORTING
!IV_TABLENAME TYPE /AWS1/DYNTABLEARN OPTIONAL
!IV_INDEXNAME TYPE /AWS1/DYNINDEXNAME OPTIONAL
!IT_ATTRIBUTESTOGET TYPE /AWS1/CL_DYNATTRNAMELIST_W=>TT_ATTRIBUTENAMELIST OPTIONAL
!IV_LIMIT TYPE /AWS1/DYNPOSITIVEINTEGEROBJECT OPTIONAL
!IV_SELECT TYPE /AWS1/DYNSELECT OPTIONAL
!IT_SCANFILTER TYPE /AWS1/CL_DYNCONDITION=>TT_FILTERCONDITIONMAP OPTIONAL
!IV_CONDITIONALOPERATOR TYPE /AWS1/DYNCONDITIONALOPERATOR OPTIONAL
!IT_EXCLUSIVESTARTKEY TYPE /AWS1/CL_DYNATTRIBUTEVALUE=>TT_KEY OPTIONAL
!IV_RETURNCONSUMEDCAPACITY TYPE /AWS1/DYNRETURNCONSUMEDCAP OPTIONAL
!IV_TOTALSEGMENTS TYPE /AWS1/DYNSCANTOTALSEGMENTS OPTIONAL
!IV_SEGMENT TYPE /AWS1/DYNSCANSEGMENT OPTIONAL
!IV_PROJECTIONEXPRESSION TYPE /AWS1/DYNPROJECTIONEXPRESSION OPTIONAL
!IV_FILTEREXPRESSION TYPE /AWS1/DYNCONDITIONEXPRESSION OPTIONAL
!IT_EXPRESSIONATTRIBUTENAMES TYPE /AWS1/CL_DYNXPRSNATTRNAMEMAP_W=>TT_EXPRESSIONATTRIBUTENAMEMAP OPTIONAL
!IT_EXPRESSIONATTRIBUTEVALUES TYPE /AWS1/CL_DYNATTRIBUTEVALUE=>TT_EXPRESSIONATTRIBUTEVALUEMAP OPTIONAL
!IV_CONSISTENTREAD TYPE /AWS1/DYNCONSISTENTREAD OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dynscanoutput
RAISING
/AWS1/CX_DYNINTERNALSERVERERR
/AWS1/CX_DYNINVALIDENDPOINTEX
/AWS1/CX_DYNPROVTHRUPUTEXCDEX
/AWS1/CX_DYNREQUESTLIMITEXCD
/AWS1/CX_DYNRESOURCENOTFOUNDEX
/AWS1/CX_DYNTHROTTLINGEX
/AWS1/CX_DYNCLIENTEXC
/AWS1/CX_DYNSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_tablename TYPE /AWS1/DYNTABLEARN /AWS1/DYNTABLEARN¶
The name of the table containing the requested items or if you provide
IndexName, the name of the table to which that index belongs.You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Optional arguments:¶
iv_indexname TYPE /AWS1/DYNINDEXNAME /AWS1/DYNINDEXNAME¶
The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the
IndexNameparameter, you must also provideTableName.
it_attributestoget TYPE /AWS1/CL_DYNATTRNAMELIST_W=>TT_ATTRIBUTENAMELIST TT_ATTRIBUTENAMELIST¶
This is a legacy parameter. Use
ProjectionExpressioninstead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
iv_limit TYPE /AWS1/DYNPOSITIVEINTEGEROBJECT /AWS1/DYNPOSITIVEINTEGEROBJECT¶
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in
LastEvaluatedKeyto apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key inLastEvaluatedKeyto apply in a subsequent operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer Guide.
iv_select TYPE /AWS1/DYNSELECT /AWS1/DYNSELECT¶
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES- Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES.
COUNT- Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.
SPECIFIC_ATTRIBUTES- Returns only the attributes listed inProjectionExpression. This return value is equivalent to specifyingProjectionExpressionwithout specifying any value forSelect.If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither
SelectnorProjectionExpressionare specified, DynamoDB defaults toALL_ATTRIBUTESwhen accessing a table, andALL_PROJECTED_ATTRIBUTESwhen accessing an index. You cannot use bothSelectandProjectionExpressiontogether in a single request, unless the value forSelectisSPECIFIC_ATTRIBUTES. (This usage is equivalent to specifyingProjectionExpressionwithout any value forSelect.)If you use the
ProjectionExpressionparameter, then the value forSelectcan only beSPECIFIC_ATTRIBUTES. Any other value forSelectwill return an error.
it_scanfilter TYPE /AWS1/CL_DYNCONDITION=>TT_FILTERCONDITIONMAP TT_FILTERCONDITIONMAP¶
This is a legacy parameter. Use
FilterExpressioninstead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
iv_conditionaloperator TYPE /AWS1/DYNCONDITIONALOPERATOR /AWS1/DYNCONDITIONALOPERATOR¶
This is a legacy parameter. Use
FilterExpressioninstead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
it_exclusivestartkey TYPE /AWS1/CL_DYNATTRIBUTEVALUE=>TT_KEY TT_KEY¶
The primary key of the first item that this operation will evaluate. Use the value that was returned for
LastEvaluatedKeyin the previous operation.The data type for
ExclusiveStartKeymust be String, Number or Binary. No set data types are allowed.In a parallel scan, a
Scanrequest that includesExclusiveStartKeymust specify the same segment whose previousScanreturned the corresponding value ofLastEvaluatedKey.
iv_returnconsumedcapacity TYPE /AWS1/DYNRETURNCONSUMEDCAP /AWS1/DYNRETURNCONSUMEDCAP¶
ReturnConsumedCapacity
iv_totalsegments TYPE /AWS1/DYNSCANTOTALSEGMENTS /AWS1/DYNSCANTOTALSEGMENTS¶
For a parallel
Scanrequest,TotalSegmentsrepresents the total number of segments into which theScanoperation will be divided. The value ofTotalSegmentscorresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify aTotalSegmentsvalue of 4.The value for
TotalSegmentsmust be greater than or equal to 1, and less than or equal to 1000000. If you specify aTotalSegmentsvalue of 1, theScanoperation will be sequential rather than parallel.If you specify
TotalSegments, you must also specifySegment.
iv_segment TYPE /AWS1/DYNSCANSEGMENT /AWS1/DYNSCANSEGMENT¶
For a parallel
Scanrequest,Segmentidentifies an individual segment to be scanned by an application worker.Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a
Segmentvalue of 0, the second thread specifies 1, and so on.The value of
LastEvaluatedKeyreturned from a parallelScanrequest must be used asExclusiveStartKeywith the same segment ID in a subsequentScanoperation.The value for
Segmentmust be greater than or equal to 0, and less than the value provided forTotalSegments.If you provide
Segment, you must also provideTotalSegments.
iv_projectionexpression TYPE /AWS1/DYNPROJECTIONEXPRESSION /AWS1/DYNPROJECTIONEXPRESSION¶
A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
iv_filterexpression TYPE /AWS1/DYNCONDITIONEXPRESSION /AWS1/DYNCONDITIONEXPRESSION¶
A string that contains conditions that DynamoDB applies after the
Scanoperation, but before the data is returned to you. Items that do not satisfy theFilterExpressioncriteria are not returned.A
FilterExpressionis applied after the items have already been read; the process of filtering does not consume any additional read capacity units.For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
it_expressionattributenames TYPE /AWS1/CL_DYNXPRSNATTRNAMEMAP_W=>TT_EXPRESSIONATTRIBUTENAMEMAP TT_EXPRESSIONATTRIBUTENAMEMAP¶
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
PercentileThe name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}You could then use this substitution in an expression, as in this example:
#P = :valTokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
it_expressionattributevalues TYPE /AWS1/CL_DYNATTRIBUTEVALUE=>TT_EXPRESSIONATTRIBUTEVALUEMAP TT_EXPRESSIONATTRIBUTEVALUEMAP¶
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the
ProductStatusattribute was one of the following:
Available | Backordered | DiscontinuedYou would first need to specify
ExpressionAttributeValuesas follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
iv_consistentread TYPE /AWS1/DYNCONSISTENTREAD /AWS1/DYNCONSISTENTREAD¶
A Boolean value that determines the read consistency model during the scan:
If
ConsistentReadisfalse, then the data returned fromScanmight not contain the results from other recently completed write operations (PutItem,UpdateItem, orDeleteItem).If
ConsistentReadistrue, then all of the write operations that completed before theScanbegan are guaranteed to be contained in theScanresponse.The default setting for
ConsistentReadisfalse.The
ConsistentReadparameter is not supported on global secondary indexes. If you scan a global secondary index withConsistentReadset to true, you will receive aValidationException.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_dynscanoutput /AWS1/CL_DYNSCANOUTPUT¶
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->scan(
it_attributestoget = VALUE /aws1/cl_dynattrnamelist_w=>tt_attributenamelist(
( new /aws1/cl_dynattrnamelist_w( |string| ) )
)
it_exclusivestartkey = VALUE /aws1/cl_dynattributevalue=>tt_key(
(
VALUE /aws1/cl_dynattributevalue=>ts_key_maprow(
value = new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_l = VALUE /aws1/cl_dynattributevalue=>tt_listattributevalue(
(
new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_m = VALUE /aws1/cl_dynattributevalue=>tt_mapattributevalue(
(
VALUE /aws1/cl_dynattributevalue=>ts_mapattributevalue_maprow(
value = new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
key = |string|
)
)
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
)
)
it_m = VALUE /aws1/cl_dynattributevalue=>tt_mapattributevalue(
(
VALUE /aws1/cl_dynattributevalue=>ts_mapattributevalue_maprow(
value = new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_l = VALUE /aws1/cl_dynattributevalue=>tt_listattributevalue(
(
new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
)
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
key = |string|
)
)
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
key = |string|
)
)
)
it_expressionattributenames = VALUE /aws1/cl_dynxprsnattrnamemap_w=>tt_expressionattributenamemap(
(
VALUE /aws1/cl_dynxprsnattrnamemap_w=>ts_xprsnattrnamemap_maprow(
value = new /aws1/cl_dynxprsnattrnamemap_w( |string| )
key = |string|
)
)
)
it_expressionattributevalues = VALUE /aws1/cl_dynattributevalue=>tt_expressionattributevaluemap(
(
VALUE /aws1/cl_dynattributevalue=>ts_xprsnattrvaluemap_maprow(
value = new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_l = VALUE /aws1/cl_dynattributevalue=>tt_listattributevalue(
(
new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_m = VALUE /aws1/cl_dynattributevalue=>tt_mapattributevalue(
(
VALUE /aws1/cl_dynattributevalue=>ts_mapattributevalue_maprow(
value = new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
key = |string|
)
)
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
)
)
it_m = VALUE /aws1/cl_dynattributevalue=>tt_mapattributevalue(
(
VALUE /aws1/cl_dynattributevalue=>ts_mapattributevalue_maprow(
value = new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_l = VALUE /aws1/cl_dynattributevalue=>tt_listattributevalue(
(
new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
)
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
key = |string|
)
)
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
key = |string|
)
)
)
it_scanfilter = VALUE /aws1/cl_dyncondition=>tt_filterconditionmap(
(
VALUE /aws1/cl_dyncondition=>ts_filterconditionmap_maprow(
value = new /aws1/cl_dyncondition(
it_attributevaluelist = VALUE /aws1/cl_dynattributevalue=>tt_attributevaluelist(
(
new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_l = VALUE /aws1/cl_dynattributevalue=>tt_listattributevalue(
(
new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_m = VALUE /aws1/cl_dynattributevalue=>tt_mapattributevalue(
(
VALUE /aws1/cl_dynattributevalue=>ts_mapattributevalue_maprow(
value = new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
key = |string|
)
)
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
)
)
it_m = VALUE /aws1/cl_dynattributevalue=>tt_mapattributevalue(
(
VALUE /aws1/cl_dynattributevalue=>ts_mapattributevalue_maprow(
value = new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_l = VALUE /aws1/cl_dynattributevalue=>tt_listattributevalue(
(
new /aws1/cl_dynattributevalue(
it_bs = VALUE /aws1/cl_dynbinarysetattrval_w=>tt_binarysetattributevalue(
( new /aws1/cl_dynbinarysetattrval_w( '5347567362473873563239796247513D' ) )
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
)
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
key = |string|
)
)
)
it_ns = VALUE /aws1/cl_dynnumsetattrvalue_w=>tt_numbersetattributevalue(
( new /aws1/cl_dynnumsetattrvalue_w( |string| ) )
)
it_ss = VALUE /aws1/cl_dynstrsetattrvalue_w=>tt_stringsetattributevalue(
( new /aws1/cl_dynstrsetattrvalue_w( |string| ) )
)
iv_b = '5347567362473873563239796247513D'
iv_bool = ABAP_TRUE
iv_n = |string|
iv_null = ABAP_TRUE
iv_s = |string|
)
)
)
iv_comparisonoperator = |string|
)
key = |string|
)
)
)
iv_conditionaloperator = |string|
iv_consistentread = ABAP_TRUE
iv_filterexpression = |string|
iv_indexname = |string|
iv_limit = 123
iv_projectionexpression = |string|
iv_returnconsumedcapacity = |string|
iv_segment = 123
iv_select = |string|
iv_tablename = |string|
iv_totalsegments = 123
).
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_items( ) into lt_row.
LOOP AT lt_row into ls_row_1.
lv_key = ls_row_1-key.
lo_value = ls_row_1-value.
IF lo_value IS NOT INITIAL.
lv_stringattributevalue = lo_value->get_s( ).
lv_numberattributevalue = lo_value->get_n( ).
lv_binaryattributevalue = lo_value->get_b( ).
LOOP AT lo_value->get_ss( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_stringattributevalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value->get_ns( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_numberattributevalue = lo_row_5->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value->get_bs( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_binaryattributevalue = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value->get_m( ) into ls_row_8.
lv_key = ls_row_8-key.
lo_value_1 = ls_row_8-value.
IF lo_value_1 IS NOT INITIAL.
lv_stringattributevalue = lo_value_1->get_s( ).
lv_numberattributevalue = lo_value_1->get_n( ).
lv_binaryattributevalue = lo_value_1->get_b( ).
LOOP AT lo_value_1->get_ss( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_stringattributevalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value_1->get_ns( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_numberattributevalue = lo_row_5->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value_1->get_bs( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_binaryattributevalue = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
" Skipping ls_row_8-value to avoid recursion
LOOP AT lo_value_1->get_l( ) into lo_row_9.
lo_row_10 = lo_row_9.
IF lo_row_10 IS NOT INITIAL.
lv_stringattributevalue = lo_row_10->get_s( ).
lv_numberattributevalue = lo_row_10->get_n( ).
lv_binaryattributevalue = lo_row_10->get_b( ).
LOOP AT lo_row_10->get_ss( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_stringattributevalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_row_10->get_ns( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_numberattributevalue = lo_row_5->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_row_10->get_bs( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_binaryattributevalue = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
" Skipping lo_row_9 to avoid recursion
" Skipping lo_row_9 to avoid recursion
lv_nullattributevalue = lo_row_10->get_null( ).
lv_booleanattributevalue = lo_row_10->get_bool( ).
ENDIF.
ENDLOOP.
lv_nullattributevalue = lo_value_1->get_null( ).
lv_booleanattributevalue = lo_value_1->get_bool( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value->get_l( ) into lo_row_9.
lo_row_10 = lo_row_9.
IF lo_row_10 IS NOT INITIAL.
lv_stringattributevalue = lo_row_10->get_s( ).
lv_numberattributevalue = lo_row_10->get_n( ).
lv_binaryattributevalue = lo_row_10->get_b( ).
LOOP AT lo_row_10->get_ss( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_stringattributevalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_row_10->get_ns( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_numberattributevalue = lo_row_5->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_row_10->get_bs( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_binaryattributevalue = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_row_10->get_m( ) into ls_row_8.
lv_key = ls_row_8-key.
lo_value_1 = ls_row_8-value.
IF lo_value_1 IS NOT INITIAL.
lv_stringattributevalue = lo_value_1->get_s( ).
lv_numberattributevalue = lo_value_1->get_n( ).
lv_binaryattributevalue = lo_value_1->get_b( ).
LOOP AT lo_value_1->get_ss( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_stringattributevalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value_1->get_ns( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_numberattributevalue = lo_row_5->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value_1->get_bs( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_binaryattributevalue = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
" Skipping ls_row_8-value to avoid recursion
" Skipping ls_row_8-value to avoid recursion
lv_nullattributevalue = lo_value_1->get_null( ).
lv_booleanattributevalue = lo_value_1->get_bool( ).
ENDIF.
ENDLOOP.
" Skipping lo_row_9 to avoid recursion
lv_nullattributevalue = lo_row_10->get_null( ).
lv_booleanattributevalue = lo_row_10->get_bool( ).
ENDIF.
ENDLOOP.
lv_nullattributevalue = lo_value->get_null( ).
lv_booleanattributevalue = lo_value->get_bool( ).
ENDIF.
ENDLOOP.
ENDLOOP.
lv_integer = lo_result->get_count( ).
lv_integer = lo_result->get_scannedcount( ).
LOOP AT lo_result->get_lastevaluatedkey( ) into ls_row_11.
lv_key = ls_row_11-key.
lo_value = ls_row_11-value.
IF lo_value IS NOT INITIAL.
lv_stringattributevalue = lo_value->get_s( ).
lv_numberattributevalue = lo_value->get_n( ).
lv_binaryattributevalue = lo_value->get_b( ).
LOOP AT lo_value->get_ss( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_stringattributevalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value->get_ns( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_numberattributevalue = lo_row_5->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value->get_bs( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_binaryattributevalue = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value->get_m( ) into ls_row_8.
lv_key = ls_row_8-key.
lo_value_1 = ls_row_8-value.
IF lo_value_1 IS NOT INITIAL.
lv_stringattributevalue = lo_value_1->get_s( ).
lv_numberattributevalue = lo_value_1->get_n( ).
lv_binaryattributevalue = lo_value_1->get_b( ).
LOOP AT lo_value_1->get_ss( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_stringattributevalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value_1->get_ns( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_numberattributevalue = lo_row_5->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value_1->get_bs( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_binaryattributevalue = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
" Skipping ls_row_8-value to avoid recursion
LOOP AT lo_value_1->get_l( ) into lo_row_9.
lo_row_10 = lo_row_9.
IF lo_row_10 IS NOT INITIAL.
lv_stringattributevalue = lo_row_10->get_s( ).
lv_numberattributevalue = lo_row_10->get_n( ).
lv_binaryattributevalue = lo_row_10->get_b( ).
LOOP AT lo_row_10->get_ss( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_stringattributevalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_row_10->get_ns( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_numberattributevalue = lo_row_5->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_row_10->get_bs( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_binaryattributevalue = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
" Skipping lo_row_9 to avoid recursion
" Skipping lo_row_9 to avoid recursion
lv_nullattributevalue = lo_row_10->get_null( ).
lv_booleanattributevalue = lo_row_10->get_bool( ).
ENDIF.
ENDLOOP.
lv_nullattributevalue = lo_value_1->get_null( ).
lv_booleanattributevalue = lo_value_1->get_bool( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value->get_l( ) into lo_row_9.
lo_row_10 = lo_row_9.
IF lo_row_10 IS NOT INITIAL.
lv_stringattributevalue = lo_row_10->get_s( ).
lv_numberattributevalue = lo_row_10->get_n( ).
lv_binaryattributevalue = lo_row_10->get_b( ).
LOOP AT lo_row_10->get_ss( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_stringattributevalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_row_10->get_ns( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_numberattributevalue = lo_row_5->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_row_10->get_bs( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_binaryattributevalue = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_row_10->get_m( ) into ls_row_8.
lv_key = ls_row_8-key.
lo_value_1 = ls_row_8-value.
IF lo_value_1 IS NOT INITIAL.
lv_stringattributevalue = lo_value_1->get_s( ).
lv_numberattributevalue = lo_value_1->get_n( ).
lv_binaryattributevalue = lo_value_1->get_b( ).
LOOP AT lo_value_1->get_ss( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_stringattributevalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value_1->get_ns( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_numberattributevalue = lo_row_5->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_value_1->get_bs( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_binaryattributevalue = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
" Skipping ls_row_8-value to avoid recursion
" Skipping ls_row_8-value to avoid recursion
lv_nullattributevalue = lo_value_1->get_null( ).
lv_booleanattributevalue = lo_value_1->get_bool( ).
ENDIF.
ENDLOOP.
" Skipping lo_row_9 to avoid recursion
lv_nullattributevalue = lo_row_10->get_null( ).
lv_booleanattributevalue = lo_row_10->get_bool( ).
ENDIF.
ENDLOOP.
lv_nullattributevalue = lo_value->get_null( ).
lv_booleanattributevalue = lo_value->get_bool( ).
ENDIF.
ENDLOOP.
lo_consumedcapacity = lo_result->get_consumedcapacity( ).
IF lo_consumedcapacity IS NOT INITIAL.
lv_tablearn = lo_consumedcapacity->get_tablename( ).
lv_consumedcapacityunits = lo_consumedcapacity->get_capacityunits( ).
lv_consumedcapacityunits = lo_consumedcapacity->get_readcapacityunits( ).
lv_consumedcapacityunits = lo_consumedcapacity->get_writecapacityunits( ).
lo_capacity = lo_consumedcapacity->get_table( ).
IF lo_capacity IS NOT INITIAL.
lv_consumedcapacityunits = lo_capacity->get_readcapacityunits( ).
lv_consumedcapacityunits = lo_capacity->get_writecapacityunits( ).
lv_consumedcapacityunits = lo_capacity->get_capacityunits( ).
ENDIF.
LOOP AT lo_consumedcapacity->get_localsecondaryindexes( ) into ls_row_12.
lv_key_1 = ls_row_12-key.
lo_value_2 = ls_row_12-value.
IF lo_value_2 IS NOT INITIAL.
lv_consumedcapacityunits = lo_value_2->get_readcapacityunits( ).
lv_consumedcapacityunits = lo_value_2->get_writecapacityunits( ).
lv_consumedcapacityunits = lo_value_2->get_capacityunits( ).
ENDIF.
ENDLOOP.
LOOP AT lo_consumedcapacity->get_globalsecondaryindexes( ) into ls_row_12.
lv_key_1 = ls_row_12-key.
lo_value_2 = ls_row_12-value.
IF lo_value_2 IS NOT INITIAL.
lv_consumedcapacityunits = lo_value_2->get_readcapacityunits( ).
lv_consumedcapacityunits = lo_value_2->get_writecapacityunits( ).
lv_consumedcapacityunits = lo_value_2->get_capacityunits( ).
ENDIF.
ENDLOOP.
ENDIF.
ENDIF.
To scan a table¶
This example scans the entire Music table, and then narrows the results to songs by the artist "No One You Know". For each item, only the album title and song title are returned.
DATA(lo_result) = lo_client->scan(
it_expressionattributenames = VALUE /aws1/cl_dynxprsnattrnamemap_w=>tt_expressionattributenamemap(
(
VALUE /aws1/cl_dynxprsnattrnamemap_w=>ts_xprsnattrnamemap_maprow(
value = new /aws1/cl_dynxprsnattrnamemap_w( |SongTitle| )
key = |#ST|
)
)
(
VALUE /aws1/cl_dynxprsnattrnamemap_w=>ts_xprsnattrnamemap_maprow(
value = new /aws1/cl_dynxprsnattrnamemap_w( |AlbumTitle| )
key = |#AT|
)
)
)
it_expressionattributevalues = VALUE /aws1/cl_dynattributevalue=>tt_expressionattributevaluemap(
(
VALUE /aws1/cl_dynattributevalue=>ts_xprsnattrvaluemap_maprow(
value = new /aws1/cl_dynattributevalue( iv_s = |No One You Know| )
key = |:a|
)
)
)
iv_filterexpression = |Artist = :a|
iv_projectionexpression = |#ST, #AT|
iv_tablename = |Music|
).