mirror of
https://github.com/fog/fog-aws.git
synced 2022-11-09 13:50:52 -05:00
43 lines
2 KiB
Ruby
43 lines
2 KiB
Ruby
module Fog
|
|
module AWS
|
|
class DynamoDB
|
|
class Real
|
|
# Scan DynamoDB items
|
|
#
|
|
# ==== Parameters
|
|
# * 'table_name'<~String> - name of table to query
|
|
# * options<~Hash>:
|
|
# * 'AttributesToGet'<~Array> - Array of attributes to get for each item, defaults to all
|
|
# * 'ConsistentRead'<~Boolean> - Whether to wait for consistency, defaults to false
|
|
# * 'Count'<~Boolean> - If true, returns only a count of such items rather than items themselves, defaults to false
|
|
# * 'Limit'<~Integer> - limit of total items to return
|
|
# * 'ScanFilter'<~Hash>: value to compare against
|
|
# * attribute_name<~Hash>:
|
|
# * 'AttributeValueList'<~Hash>: one or more values to compare against
|
|
# * 'ComparisonOperator'<~String>: comparison operator to use with attribute value list, in %w{BETWEEN BEGINS_WITH EQ LE LT GE GT}
|
|
# * 'ScanIndexForward'<~Boolean>: Whether to scan from start or end of index, defaults to start
|
|
# * 'ExclusiveStartKey'<~Hash>: Key to start listing from, can be taken from LastEvaluatedKey in response
|
|
#
|
|
# ==== Returns
|
|
# * response<~Excon::Response>:
|
|
# * body<~Hash>:
|
|
# * 'ConsumedCapacityUnits'<~Integer> - number of capacity units used for scan
|
|
# * 'Count'<~Integer> - number of items in response
|
|
# * 'Items'<~Array> - array of items returned
|
|
# * 'LastEvaluatedKey'<~Hash> - last key scanned, can be passed to ExclusiveStartKey for pagination
|
|
# * 'ScannedCount'<~Integer> - number of items scanned before applying filters
|
|
def scan(table_name, options = {})
|
|
body = {
|
|
'TableName' => table_name
|
|
}.merge(options)
|
|
|
|
request(
|
|
:body => Fog::JSON.encode(body),
|
|
:headers => {'x-amz-target' => 'DynamoDB_20111205.Scan'},
|
|
:idempotent => true
|
|
)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|