Interface ScanApi

  • All Known Implementing Classes:
    Index, Table

    public interface ScanApi
    A Table-centric Scan API.
    • Method Detail

      • scan

        ItemCollection<ScanOutcome> scan​(String filterExpression,
                                         Map<String,​String> nameMap,
                                         Map<String,​Object> valueMap)
        Scans table using a Filter Expression.
        Parameters:
        filterExpression - condition expression example: "(#a > :a) AND (#c > :c OR #e < :e)"
        nameMap - actual values for the attribute-name place holders; can be null if there is no attribute-name placeholder.
        valueMap - actual values for the value place holders can be null if there is no attribute-value placeholder.
      • scan

        ItemCollection<ScanOutcome> scan​(String filterExpression,
                                         String projectionExpression,
                                         Map<String,​String> nameMap,
                                         Map<String,​Object> valueMap)
        Scans table using a Filter Expression and a Projection Expression.
        Parameters:
        filterExpression - condition expression example: "(#a > :a) AND (#c > :c OR #e < :e)"
        projectionExpression - projection expression example: "a.b , c[0].e"
        nameMap - actual values for the attribute-name place holders; can be null if there is no attribute-name placeholder.
        valueMap - actual values for the value place holders can be null if there is no attribute-value placeholder.