Aws.DynamoDb.Commands.Scan

Implementation of Amazon DynamoDb Scan command.

See: http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html

Documentation

data Scan

A Scan command that uses primary keys for an expedient scan.

Constructors

Scan

Fields

• sTableName :: Text

  Required.

• sConsistentRead :: Bool

  Whether to require a consistent read

• sFilter :: Conditions

  Whether to filter results before returning to client

• sStartKey :: Maybe [Attribute]

  Exclusive start key to resume a previous query.

• sLimit :: Maybe Int

  Whether to limit result set size

• sIndex :: Maybe Text

  Optional. Index to Scan

• sSelect :: QuerySelect

  What to return from Scan

• sRetCons :: ReturnConsumption
• sSegment :: Int

  Segment number, starting at 0, for parallel queries.

• sTotalSegments :: Int

  Total number of parallel segments. 1 means sequential scan.

Instances

Eq Scan

Methods

(==) :: Scan -> Scan -> Bool

(/=) :: Scan -> Scan -> Bool

Ord Scan

Methods

compare :: Scan -> Scan -> Ordering

(<) :: Scan -> Scan -> Bool

(<=) :: Scan -> Scan -> Bool

(>) :: Scan -> Scan -> Bool

(>=) :: Scan -> Scan -> Bool

max :: Scan -> Scan -> Scan

min :: Scan -> Scan -> Scan

Read Scan

Methods

readsPrec :: Int -> ReadS Scan

readList :: ReadS [Scan]

readPrec :: ReadPrec Scan

readListPrec :: ReadPrec [Scan]

Show Scan

Methods

showsPrec :: Int -> Scan -> ShowS

show :: Scan -> String

showList :: [Scan] -> ShowS

ToJSON Scan

Methods

toJSON :: Scan -> Value

toEncoding :: Scan -> Encoding

toJSONList :: [Scan] -> Value

toEncodingList :: [Scan] -> Encoding

SignQuery Scan

Associated Types

type ServiceConfiguration Scan :: * -> *

Methods

signQuery :: Scan -> ServiceConfiguration Scan queryType -> SignatureData -> SignedQuery

IteratedTransaction Scan ScanResponse

Methods

nextIteratedRequest :: Scan -> ScanResponse -> Maybe Scan

Transaction Scan ScanResponse

type ServiceConfiguration Scan

type ServiceConfiguration Scan = DdbConfiguration

scan

Arguments

:: Text

Table name

-> Scan

Construct a minimal Scan request.

data ScanResponse

Response to a Scan query.

Constructors

ScanResponse

Fields

• srItems :: Vector Item
• srLastKey :: Maybe [Attribute]
• srCount :: Int
• srScanned :: Int
• srConsumed :: Maybe ConsumedCapacity

Instances

Eq ScanResponse

Methods

(==) :: ScanResponse -> ScanResponse -> Bool

(/=) :: ScanResponse -> ScanResponse -> Bool

Ord ScanResponse

Methods

compare :: ScanResponse -> ScanResponse -> Ordering

(<) :: ScanResponse -> ScanResponse -> Bool

(<=) :: ScanResponse -> ScanResponse -> Bool

(>) :: ScanResponse -> ScanResponse -> Bool

(>=) :: ScanResponse -> ScanResponse -> Bool

max :: ScanResponse -> ScanResponse -> ScanResponse

min :: ScanResponse -> ScanResponse -> ScanResponse

Read ScanResponse

Methods

readsPrec :: Int -> ReadS ScanResponse

readList :: ReadS [ScanResponse]

readPrec :: ReadPrec ScanResponse

readListPrec :: ReadPrec [ScanResponse]

Show ScanResponse

Methods

showsPrec :: Int -> ScanResponse -> ShowS

show :: ScanResponse -> String

showList :: [ScanResponse] -> ShowS

FromJSON ScanResponse

Methods

parseJSON :: Value -> Parser ScanResponse

parseJSONList :: Value -> Parser [ScanResponse]

AsMemoryResponse ScanResponse

Associated Types

type MemoryResponse ScanResponse :: *

Methods

loadToMemory :: ScanResponse -> ResourceT IO (MemoryResponse ScanResponse)

IteratedTransaction Scan ScanResponse

Methods

nextIteratedRequest :: Scan -> ScanResponse -> Maybe Scan

Transaction Scan ScanResponse

ListResponse ScanResponse Item

Methods

listResponse :: ScanResponse -> [Item]

ResponseConsumer r ScanResponse

Associated Types

type ResponseMetadata ScanResponse :: *

Methods

responseConsumer :: Request -> r -> IORef (ResponseMetadata ScanResponse) -> HTTPResponseConsumer ScanResponse

type MemoryResponse ScanResponse

type MemoryResponse ScanResponse = ScanResponse

type ResponseMetadata ScanResponse

type ResponseMetadata ScanResponse = DdbResponse