class Amazonite::DynamoDB::ScanOutput

Overview

Represents the output of a Scan operation.

Included Modules

JSON::Serializable

Defined in:

dynamodb/scan_output.cr

Constructors

.new(pull : JSON::PullParser)
.new(items : Array(Hash(String, AttributeValue)) | Nil = nil, count : Int32 | Nil = nil, scanned_count : Int32 | Nil = nil, last_evaluated_key : Hash(String, AttributeValue) | Nil = nil, consumed_capacity : ConsumedCapacity | Nil = nil)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

#==(other : self)
Returns true if this reference is the same as other.
#consumed_capacity : ConsumedCapacity | Nil
The capacity units consumed by the Scan operation.
#consumed_capacity=(consumed_capacity : ConsumedCapacity | Nil)
The capacity units consumed by the Scan operation.
#count : Int32 | Nil
The number of items in the response.
#count=(count : Int32 | Nil)
The number of items in the response.
#hash(hasher)
See Object#hash(hasher)
#items : Array(Hash(String, AttributeValue)) | Nil
An array of item attributes that match the scan criteria.
#items=(items : Array(Hash(String, AttributeValue)) | Nil)
An array of item attributes that match the scan criteria.
#last_evaluated_key : Hash(String, AttributeValue) | Nil
The primary key of the item where the operation stopped, inclusive of the previous result set.
#last_evaluated_key=(last_evaluated_key : Hash(String, AttributeValue) | Nil)
The primary key of the item where the operation stopped, inclusive of the previous result set.
#scanned_count : Int32 | Nil
The number of items evaluated, before any ScanFilter is applied.
#scanned_count=(scanned_count : Int32 | Nil)
The number of items evaluated, before any ScanFilter is applied.
#validate! : Nil

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]

[View source]

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #

Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.

def consumed_capacity : ConsumedCapacity | Nil #

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

[View source]

def consumed_capacity=(consumed_capacity : ConsumedCapacity | Nil) #

[View source]

def count : Int32 | Nil #

The number of items in the response.

If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count is the same as ScannedCount.

[View source]

def count=(count : Int32 | Nil) #

The number of items in the response.

If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count is the same as ScannedCount.

[View source]

def hash(hasher) #

Description copied from class Reference

See Object#hash(hasher)

def items : Array(Hash(String, AttributeValue)) | Nil #

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

[View source]

def items=(items : Array(Hash(String, AttributeValue)) | Nil) #

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

[View source]

def last_evaluated_key : Hash(String, AttributeValue) | Nil #

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

[View source]

def last_evaluated_key=(last_evaluated_key : Hash(String, AttributeValue) | Nil) #

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

[View source]

def scanned_count : Int32 | Nil #

The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

[View source]

def scanned_count=(scanned_count : Int32 | Nil) #

If you did not use a filter in the request, then ScannedCount is the same as Count.

[View source]

def validate! : Nil #

[View source]