ExAirtable.TableCache (ExAirtable v0.2.9) View Source

A caching server for an ExAirtable.Table.

Given a module name that implements the Table behaviour, it will automatically spawn synchronization processes and provide an in-memory data store that stays in sync with the external Airtable table/base.

Examples

iex> TableCache.retrieve(MyAirtableTable, "rec1234")
%Airtable.Record{}

iex> TableCache.list(MyAirtableTable)
%Airtable.List{records: [%Airtable.Record{}, ...]}

Link to this section Summary

Types

t()

A struct that contains the state for a TableCache.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

delete(table_module, map)

Given an ExAirtable.Table module and an ID map, delete the record matching that ID.

init(opts)

Initialize the caching server.

list(table_module)

Given an ExAirtable.Table module, get all %Airtable.Record{}s in that cache's table as an %Airtable.List{}.

push_paginated_list(table_module, list)

Given an ExAirtable.Table module, and a list result, store that result for later cache replacement.

retrieve(table_module, key)

Given an ExAirtable.Table module and a string key, get the %Record{} in that cache with the matching key.

set(table_module, id, item)

Given an ExAirtable.Table module, an ID, and a corresponding item to match that ID, store it in the cache.

set_all(table_module, list)

Replace an entire cache with a new set of %ExAirtable.Airtable.Record{}s.

start_link(opts)

Start a caching server.

table_for(table_module)

Returns a valid ETS table name for a given ExAirtable.Table module.

update(table_module, list)

Given an ExAirtable.Table module and an ExAirtable.Airtable.Record{} struct, update the matching record in the cache, and insert it if it doesn't exist.

Link to this section Types

t()

Specs

t() :: %ExAirtable.TableCache{
  hash: String.t(),
  sync_rate: integer(),
  sync_ref: pid(),
  table_module: module()
}