Airtable.Table

Record

data Record a

An airtable record.

Constructors

Record

Fields

• recordId :: RecordID
• recordObj :: a
• createdTime :: UTCTime

Instances

Functor Record

Methods

fmap :: (a -> b) -> Record a -> Record b

(<$) :: a -> Record b -> Record a

Eq a => Eq (Record a)

Methods

(==) :: Record a -> Record a -> Bool

(/=) :: Record a -> Record a -> Bool

Ord a => Ord (Record a)

Methods

compare :: Record a -> Record a -> Ordering

(<) :: Record a -> Record a -> Bool

(<=) :: Record a -> Record a -> Bool

(>) :: Record a -> Record a -> Bool

(>=) :: Record a -> Record a -> Bool

max :: Record a -> Record a -> Record a

min :: Record a -> Record a -> Record a

Read a => Read (Record a)

Methods

readsPrec :: Int -> ReadS (Record a)

readList :: ReadS [Record a]

readPrec :: ReadPrec (Record a)

readListPrec :: ReadPrec [Record a]

Show a => Show (Record a)

Methods

showsPrec :: Int -> Record a -> ShowS

show :: Record a -> String

showList :: [Record a] -> ShowS

Generic (Record a)

Associated Types

type Rep (Record a) :: * -> *

Methods

from :: Record a -> Rep (Record a) x

to :: Rep (Record a) x -> Record a

ToJSON a => ToJSON (Record a)

Methods

toJSON :: Record a -> Value

toEncoding :: Record a -> Encoding

toJSONList :: [Record a] -> Value

toEncodingList :: [Record a] -> Encoding

FromJSON a => FromJSON (Record a)

Methods

parseJSON :: Value -> Parser (Record a)

parseJSONList :: Value -> Parser [Record a]

HasRecordId (Record a)

Methods

toRecId :: Record a -> RecordID

type Rep (Record a)

type Rep (Record a) = D1 (MetaData "Record" "Airtable.Table" "airtable-api-0.3.2.4-1b5HaNvaRlv8BV4bY4128D" False) (C1 (MetaCons "Record" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "recordId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RecordID)) ((:*:) (S1 (MetaSel (Just Symbol "recordObj") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) (S1 (MetaSel (Just Symbol "createdTime") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UTCTime)))))

RecordID

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

Read RecordID

Methods

readsPrec :: Int -> ReadS RecordID

readList :: ReadS [RecordID]

readPrec :: ReadPrec RecordID

readListPrec :: ReadPrec [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

ToJSON RecordID

Methods

toJSON :: RecordID -> Value

toEncoding :: RecordID -> Encoding

toJSONList :: [RecordID] -> Value

toEncodingList :: [RecordID] -> Encoding

FromJSON RecordID

Methods

parseJSON :: Value -> Parser RecordID

parseJSONList :: Value -> Parser [RecordID]

HasRecordId RecordID

Methods

toRecId :: RecordID -> RecordID

type Rep RecordID

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

rec2str :: RecordID -> String

HasRecordId class

class HasRecordId a where

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

Minimal complete definition

toRecId

Methods

toRecId :: a -> RecordID

Instances

HasRecordId String

Methods

toRecId :: String -> RecordID

HasRecordId RecordID

Methods

toRecId :: RecordID -> RecordID

HasRecordId (Record a)

Methods

toRecId :: Record a -> RecordID

Table

data Table a

An airtable table.

Constructors

Table

Fields

• tableRecords :: HashMap RecordID (Record a)

  A mapping from RecordID to Record

• tableOffset :: Maybe Text

  The "offset" parameter for the table. Is used to deal with airtable's pagination.

Instances

Functor Table

Methods

fmap :: (a -> b) -> Table a -> Table b

(<$) :: a -> Table b -> Table a

Eq a => Eq (Table a)

Methods

(==) :: Table a -> Table a -> Bool

(/=) :: Table a -> Table a -> Bool

Read a => Read (Table a)

Methods

readsPrec :: Int -> ReadS (Table a)

readList :: ReadS [Table a]

readPrec :: ReadPrec (Table a)

readListPrec :: ReadPrec [Table a]

Show a => Show (Table a)

Methods

showsPrec :: Int -> Table a -> ShowS

show :: Table a -> String

showList :: [Table a] -> ShowS

Generic (Table a)

Associated Types

type Rep (Table a) :: * -> *

Methods

from :: Table a -> Rep (Table a) x

to :: Rep (Table a) x -> Table a

Monoid (Table a)

Methods

mempty :: Table a

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

mconcat :: [Table a] -> Table a

ToJSON a => ToJSON (Table a)

Methods

toJSON :: Table a -> Value

toEncoding :: Table a -> Encoding

toJSONList :: [Table a] -> Value

toEncodingList :: [Table a] -> Encoding

FromJSON a => FromJSON (Table a)

Methods

parseJSON :: Value -> Parser (Table a)

parseJSONList :: Value -> Parser [Table a]

type Rep (Table a)

type Rep (Table a) = D1 (MetaData "Table" "Airtable.Table" "airtable-api-0.3.2.4-1b5HaNvaRlv8BV4bY4128D" False) (C1 (MetaCons "Table" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "tableRecords") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HashMap RecordID (Record a)))) (S1 (MetaSel (Just Symbol "tableOffset") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))))

type TableName = String

Synonym used in querying tables from the API.

Table methods

fromRecords :: [Record a] -> Table a

Create a Table from a list of Records.

fromList :: [(RecordID, Record a)] -> Table a

Create a table from a list of key-record pairs.

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

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

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

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

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

Unsafely lookup a record using its RecordID. Will throw a pretty-printed error if record does not exist.

vSelect :: (HasCallStack, HasRecordId r, Show a) => Table a -> r -> a

Same as select, but returns the record object.

selectMaybe :: HasRecordId r => Table a -> r -> Maybe (Record a)

Safely lookup a record using its RecordID.

vSelectMaybe :: HasRecordId r => Table a -> r -> Maybe a

Same as selectMaybe, but returns the record object.

selectAll :: Table a -> [Record a]

Read all records.

vSelectAll :: Table a -> [a]

Same as selectAll, but returns the record object.

selectAllKeys :: Table a -> [RecordID]

Read all RecordID's.

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

Select all records satisfying a condition.

vSelectWhere :: Table a -> (a -> Bool) -> [a]

Same as selectWhere, but returns the record object.

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

Select all records satisfying a condition.

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

Same as selectKeyWhere, but returns the record object.

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

Delete all Records satisfying a condition.

vDeleteWhere :: Table a -> (a -> Bool) -> Table a

Same as deleteWhere, but returns the record object.