Airtable.Table

Documentation

newtype RecordID

Airtable's record ID for use in indexing records

Constructors

RecordID Text

Instances

Eq RecordID

Methods

(==) :: RecordID -> RecordID -> Bool

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

Ord RecordID

Methods

compare :: RecordID -> RecordID -> Ordering

(<) :: RecordID -> RecordID -> Bool

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

(>) :: RecordID -> RecordID -> Bool

(>=) :: RecordID -> RecordID -> Bool

max :: RecordID -> RecordID -> RecordID

min :: RecordID -> RecordID -> RecordID

Show RecordID

Methods

showsPrec :: Int -> RecordID -> ShowS

show :: RecordID -> String

showList :: [RecordID] -> ShowS

Generic RecordID

Associated Types

type Rep RecordID :: * -> *

Methods

from :: RecordID -> Rep RecordID x

to :: Rep RecordID x -> RecordID

Hashable RecordID

Methods

hashWithSalt :: Int -> RecordID -> Int

hash :: RecordID -> Int

FromJSON RecordID

Methods

parseJSON :: Value -> Parser RecordID

parseJSONList :: Value -> Parser [RecordID]

IsRecord RecordID

Methods

toRec :: RecordID -> RecordID

type Rep RecordID

type Rep RecordID = D1 (MetaData "RecordID" "Airtable.Table" "airtable-api-0.1.0.1-vXulXDZtwOjK9FFigKzQ" True) (C1 (MetaCons "RecordID" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

rec2str :: RecordID -> String

class IsRecord a where

A convenience typeclass for selecting records using RecordID-like keys.

Minimal complete definition

toRec

Methods

toRec :: a -> RecordID

Instances

IsRecord String

Methods

toRec :: String -> RecordID

IsRecord RecordID

Methods

toRec :: RecordID -> RecordID

data Table a

Airtable's table type

Constructors

Table

Fields

• tableRecords :: HashMap RecordID a
• tableOffset :: Maybe Text

Instances

Show a => Show (Table a)

Methods

showsPrec :: Int -> Table a -> ShowS

show :: Table a -> String

showList :: [Table a] -> ShowS

Monoid (Table a)

Methods

mempty :: Table a

mappend :: Table a -> Table a -> Table a

mconcat :: [Table a] -> Table a

FromJSON a => FromJSON (Table a)

Methods

parseJSON :: Value -> Parser (Table a)

parseJSONList :: Value -> Parser [Table a]

type TableName = String

Synonym used in querying tables from the API.

toList :: Table a -> [(RecordID, a)]

Convert a Table to a list of key-record pairs.

exists :: IsRecord r => Table a -> r -> Bool

Check if a record exists at the given key in a table.

select :: (HasCallStack, IsRecord r, Show a) => Table a -> r -> a

Unsafely lookup a record using its RecordID.

selectMaybe :: (IsRecord r, Show a) => Table a -> r -> Maybe a

Safely lookup a record using its RecordID.

selectAll :: Table a -> [a]

Read all records.

selectAllKeys :: Table a -> [RecordID]

Read all RecordID's.

selectWhere :: Table a -> (RecordID -> a -> Bool) -> [a]

Select all records satisfying a condition.

selectKeyWhere :: Table a -> (RecordID -> a -> Bool) -> [RecordID]

Select all RecordID's satisfying a condition.

deleteWhere :: Table a -> (RecordID -> a -> Bool) -> Table a

Delete all Records satisfying a condition.