Module

Yoga.DynamoDB.DynamoDB

Package: purescript-yoga-dynamodb
Repository: rowtype-yoga/purescript-yoga-dynamodb

#DynamoDB Source

data DynamoDB

#DynamoDBItem Source

data DynamoDBItem

#Region Source

newtype Region

Constructors

Region String

Instances

#Endpoint Source

newtype Endpoint

Constructors

Endpoint String

Instances

#AccessKeyId Source

newtype AccessKeyId

Constructors

AccessKeyId String

Instances

#SecretAccessKey Source

newtype SecretAccessKey

Constructors

SecretAccessKey String

Instances

#SessionToken Source

newtype SessionToken

Constructors

SessionToken String

Instances

#TableName Source

newtype TableName

Constructors

TableName String

Instances

#IndexName Source

newtype IndexName

Constructors

IndexName String

Instances

#AttributeName Source

newtype AttributeName

Constructors

AttributeName String

Instances

#AttributeValue Source

newtype AttributeValue

Constructors

AttributeValue Foreign

Instances

Newtype AttributeValue _

#KeyConditionExpression Source

newtype KeyConditionExpression

Constructors

KeyConditionExpression String

Instances

#FilterExpression Source

newtype FilterExpression

Constructors

FilterExpression String

Instances

#ProjectionExpression Source

newtype ProjectionExpression

Constructors

ProjectionExpression String

Instances

#ConditionExpression Source

newtype ConditionExpression

Constructors

ConditionExpression String

Instances

#UpdateExpression Source

newtype UpdateExpression

Constructors

UpdateExpression String

Instances

#Limit Source

newtype Limit

Constructors

Limit Int

Instances

#toItem Source

toItem :: Foreign -> DynamoDBItem

#fromItem Source

fromItem :: DynamoDBItem -> Foreign

#ExpressionAttributeValues Source

type ExpressionAttributeValues = Object Foreign

#ExpressionAttributeNames Source

type ExpressionAttributeNames = Object String

#attrNames Source

attrNames :: forall r. Record r -> ExpressionAttributeNames

#attrValues Source

attrValues :: forall r. Record r -> ExpressionAttributeValues

#attrName Source

attrName :: String -> String -> ExpressionAttributeNames

#attrValue Source

attrValue :: forall a. String -> a -> ExpressionAttributeValues

#DynamoDBConfigImpl Source

type DynamoDBConfigImpl :: Row Typetype DynamoDBConfigImpl = (credentials :: { accessKeyId :: AccessKeyId, secretAccessKey :: SecretAccessKey, sessionToken :: SessionToken }, endpoint :: Endpoint, maxAttempts :: Int, region :: Region, requestTimeout :: Int)

#createDynamoDBImpl Source

createDynamoDBImpl :: forall opts. EffectFn1 (Record opts) DynamoDB

#createDynamoDB Source

createDynamoDB :: forall opts opts_. Union opts opts_ DynamoDBConfigImpl => Record opts -> Effect DynamoDB

#PutItemOptionsImpl Source

type PutItemOptionsImpl :: Row Typetype PutItemOptionsImpl = (conditionExpression :: ConditionExpression, expressionAttributeNames :: ExpressionAttributeNames, expressionAttributeValues :: ExpressionAttributeValues, returnValues :: String)

#PutItemResult Source

type PutItemResult = { attributes :: Maybe DynamoDBItem }

#putItemImpl Source

putItemImpl :: forall opts. EffectFn2 DynamoDB { item :: DynamoDBItem, tableName :: TableName | opts } (Promise { attributes :: Nullable DynamoDBItem })

#putItem Source

putItem :: TableName -> DynamoDBItem -> DynamoDB -> Aff PutItemResult

#putItemWithOptions Source

putItemWithOptions :: forall opts opts_. Union opts opts_ PutItemOptionsImpl => TableName -> DynamoDBItem -> Record opts -> DynamoDB -> Aff PutItemResult

#GetItemOptionsImpl Source

type GetItemOptionsImpl :: Row Typetype GetItemOptionsImpl = (consistentRead :: Boolean, expressionAttributeNames :: ExpressionAttributeNames, projectionExpression :: ProjectionExpression)

#getItemImpl Source

getItemImpl :: forall opts. EffectFn2 DynamoDB { key :: DynamoDBItem, tableName :: TableName | opts } (Promise { item :: Nullable DynamoDBItem })

#getItem Source

getItem :: TableName -> DynamoDBItem -> DynamoDB -> Aff (Maybe DynamoDBItem)

#getItemWithOptions Source

getItemWithOptions :: forall opts opts_. Union opts opts_ GetItemOptionsImpl => TableName -> DynamoDBItem -> Record opts -> DynamoDB -> Aff (Maybe DynamoDBItem)

#UpdateItemOptionsImpl Source

type UpdateItemOptionsImpl :: Row Typetype UpdateItemOptionsImpl = (conditionExpression :: ConditionExpression, expressionAttributeNames :: ExpressionAttributeNames, expressionAttributeValues :: ExpressionAttributeValues, returnValues :: String)

#UpdateItemResult Source

type UpdateItemResult = { attributes :: Maybe DynamoDBItem }

#updateItemImpl Source

updateItemImpl :: forall opts. EffectFn2 DynamoDB { key :: DynamoDBItem, tableName :: TableName, updateExpression :: UpdateExpression | opts } (Promise { attributes :: Nullable DynamoDBItem })

#updateItem Source

updateItem :: TableName -> DynamoDBItem -> UpdateExpression -> DynamoDB -> Aff UpdateItemResult

#updateItemWithOptions Source

updateItemWithOptions :: forall opts opts_. Union opts opts_ UpdateItemOptionsImpl => TableName -> DynamoDBItem -> UpdateExpression -> Record opts -> DynamoDB -> Aff UpdateItemResult

#DeleteItemOptionsImpl Source

type DeleteItemOptionsImpl :: Row Typetype DeleteItemOptionsImpl = (conditionExpression :: ConditionExpression, expressionAttributeNames :: ExpressionAttributeNames, expressionAttributeValues :: ExpressionAttributeValues, returnValues :: String)

#DeleteItemResult Source

type DeleteItemResult = { attributes :: Maybe DynamoDBItem }

#deleteItemImpl Source

deleteItemImpl :: forall opts. EffectFn2 DynamoDB { key :: DynamoDBItem, tableName :: TableName | opts } (Promise { attributes :: Nullable DynamoDBItem })

#deleteItem Source

deleteItem :: TableName -> DynamoDBItem -> DynamoDB -> Aff DeleteItemResult

#deleteItemWithOptions Source

deleteItemWithOptions :: forall opts opts_. Union opts opts_ DeleteItemOptionsImpl => TableName -> DynamoDBItem -> Record opts -> DynamoDB -> Aff DeleteItemResult

#QueryOptionsImpl Source

type QueryOptionsImpl :: Row Typetype QueryOptionsImpl = (consistentRead :: Boolean, exclusiveStartKey :: DynamoDBItem, expressionAttributeNames :: ExpressionAttributeNames, expressionAttributeValues :: ExpressionAttributeValues, filterExpression :: FilterExpression, indexName :: IndexName, limit :: Limit, projectionExpression :: ProjectionExpression, scanIndexForward :: Boolean)

#QueryResult Source

type QueryResult = { count :: Int, items :: Array DynamoDBItem, lastEvaluatedKey :: Maybe DynamoDBItem, scannedCount :: Int }

#queryImpl Source

queryImpl :: forall opts. EffectFn2 DynamoDB { keyConditionExpression :: KeyConditionExpression, tableName :: TableName | opts } (Promise { count :: Int, items :: Array DynamoDBItem, lastEvaluatedKey :: Nullable DynamoDBItem, scannedCount :: Int })

#query Source

query :: TableName -> KeyConditionExpression -> DynamoDB -> Aff QueryResult

#queryWithOptions Source

queryWithOptions :: forall opts opts_. Union opts opts_ QueryOptionsImpl => TableName -> KeyConditionExpression -> Record opts -> DynamoDB -> Aff QueryResult

#ScanOptionsImpl Source

type ScanOptionsImpl :: Row Typetype ScanOptionsImpl = (consistentRead :: Boolean, exclusiveStartKey :: DynamoDBItem, expressionAttributeNames :: ExpressionAttributeNames, expressionAttributeValues :: ExpressionAttributeValues, filterExpression :: FilterExpression, indexName :: IndexName, limit :: Limit, projectionExpression :: ProjectionExpression)

#ScanResult Source

type ScanResult = { count :: Int, items :: Array DynamoDBItem, lastEvaluatedKey :: Maybe DynamoDBItem, scannedCount :: Int }

#scanImpl Source

scanImpl :: forall opts. EffectFn2 DynamoDB { tableName :: TableName | opts } (Promise { count :: Int, items :: Array DynamoDBItem, lastEvaluatedKey :: Nullable DynamoDBItem, scannedCount :: Int })

#scan Source

scan :: TableName -> DynamoDB -> Aff ScanResult

#scanWithOptions Source

scanWithOptions :: forall opts opts_. Union opts opts_ ScanOptionsImpl => TableName -> Record opts -> DynamoDB -> Aff ScanResult

#BatchGetRequestItems Source

type BatchGetRequestItems = Object { keys :: Array DynamoDBItem, projectionExpression :: Maybe ProjectionExpression }

#BatchGetResponses Source

type BatchGetResponses = Object (Array DynamoDBItem)

#BatchGetResult Source

type BatchGetResult = { responses :: BatchGetResponses, unprocessedKeys :: Object (Array DynamoDBItem) }

#batchGetItemImpl Source

batchGetItemImpl :: EffectFn2 DynamoDB Foreign (Promise { responses :: Foreign, unprocessedKeys :: Foreign })

#batchGetItem Source

batchGetItem :: Foreign -> DynamoDB -> Aff BatchGetResult

#PutRequest Source

type PutRequest = { item :: DynamoDBItem }

#DeleteRequest Source

type DeleteRequest = { key :: DynamoDBItem }

#WriteRequest Source

type WriteRequest = { deleteRequest :: Maybe DeleteRequest, putRequest :: Maybe PutRequest }

#BatchWriteResult Source

type BatchWriteResult = { unprocessedItems :: Object (Array WriteRequest) }

#batchWriteItemImpl Source

batchWriteItemImpl :: EffectFn2 DynamoDB Foreign (Promise { unprocessedItems :: Foreign })

#batchWriteItem Source

batchWriteItem :: Foreign -> DynamoDB -> Aff BatchWriteResult

#TransactGetItem Source

type TransactGetItem = { key :: DynamoDBItem, tableName :: TableName }

#TransactPutItem Source

type TransactPutItem = { conditionExpression :: Maybe ConditionExpression, item :: DynamoDBItem, tableName :: TableName }

#TransactUpdateItem Source

type TransactUpdateItem = { key :: DynamoDBItem, tableName :: TableName, updateExpression :: UpdateExpression }

#TransactDeleteItem Source

type TransactDeleteItem = { conditionExpression :: Maybe ConditionExpression, key :: DynamoDBItem, tableName :: TableName }

#TransactGetResult Source

type TransactGetResult = { responses :: Array { item :: Maybe DynamoDBItem } }

#transactGetItemsImpl Source

transactGetItemsImpl :: EffectFn2 DynamoDB (Array Foreign) (Promise { responses :: Array { item :: Nullable DynamoDBItem } })

#transactGetItems Source

transactGetItems :: Array Foreign -> DynamoDB -> Aff TransactGetResult

#transactWriteItemsImpl Source

transactWriteItemsImpl :: EffectFn2 DynamoDB (Array Foreign) (Promise Unit)

#transactWriteItems Source

transactWriteItems :: Array Foreign -> DynamoDB -> Aff Unit

#AttributeDefinition Source

type AttributeDefinition = { attributeName :: String, attributeType :: String }

#KeySchemaElement Source

type KeySchemaElement = { attributeName :: String, keyType :: String }

#ProvisionedThroughput Source

type ProvisionedThroughput = { readCapacityUnits :: Int, writeCapacityUnits :: Int }

#GlobalSecondaryIndex Source

type GlobalSecondaryIndex = { indexName :: IndexName, keySchema :: Array KeySchemaElement, projection :: { projectionType :: String }, provisionedThroughput :: Maybe ProvisionedThroughput }

#LocalSecondaryIndex Source

type LocalSecondaryIndex = { indexName :: IndexName, keySchema :: Array KeySchemaElement, projection :: { projectionType :: String } }

#StreamSpecification Source

type StreamSpecification = { streamEnabled :: Boolean, streamViewType :: String }

#Tag Source

type Tag = { key :: String, value :: String }

#CreateTableOptionsImpl Source

type CreateTableOptionsImpl :: Row Typetype CreateTableOptionsImpl = (billingMode :: String, globalSecondaryIndexes :: Array GlobalSecondaryIndex, localSecondaryIndexes :: Array LocalSecondaryIndex, provisionedThroughput :: ProvisionedThroughput, streamSpecification :: StreamSpecification, tags :: Array Tag)

#createTableImpl Source

createTableImpl :: forall opts. EffectFn2 DynamoDB { attributeDefinitions :: Array AttributeDefinition, keySchema :: Array KeySchemaElement, tableName :: TableName | opts } (Promise Foreign)

#createTable Source

createTable :: forall opts opts_. Union opts opts_ CreateTableOptionsImpl => { attributeDefinitions :: Array AttributeDefinition, keySchema :: Array KeySchemaElement, tableName :: TableName | opts } -> DynamoDB -> Aff Foreign

#describeTableImpl Source

describeTableImpl :: EffectFn2 DynamoDB TableName (Promise Foreign)

#describeTable Source

describeTable :: TableName -> DynamoDB -> Aff Foreign

#deleteTableImpl Source

deleteTableImpl :: EffectFn2 DynamoDB TableName (Promise Foreign)

#deleteTable Source

deleteTable :: TableName -> DynamoDB -> Aff Foreign

#ListTablesResult Source

type ListTablesResult = { lastEvaluatedTableName :: Maybe TableName, tableNames :: Array TableName }

#listTablesImpl Source

listTablesImpl :: EffectFn2 DynamoDB (Nullable Int) (Promise { lastEvaluatedTableName :: Nullable TableName, tableNames :: Array TableName })

#listTables Source

listTables :: DynamoDB -> Aff ListTablesResult

#listTablesLimit Source

listTablesLimit :: Int -> DynamoDB -> Aff ListTablesResult

Modules: Yoga.DynamoDB.DynamoDB