Phoenix.Sync.PredefinedShape (Phoenix.Sync v0.6.1)

View Source

Summary

Types

option()

@type option() ::
  {:table, binary()}
  | {:where, nil | binary()}
  | {:columns, nil | [binary()]}
  | {:namespace, nil | binary()}
  | {:params,
     nil
     | %{optional(pos_integer()) => binary() | integer() | float() | boolean()}
     | [binary() | integer() | float() | boolean()]}
  | {:replica, term()}
  | {:transform, {module(), atom(), [term()]} | (term() -> term()) | atom()}
  | {:storage, map() | nil}

options()

@type options() :: [option()]

shape()

@type shape() :: options() | Phoenix.Sync.queryable()

t()

@type t() :: %Phoenix.Sync.PredefinedShape{
  api_config: term(),
  query: term(),
  shape_config: term(),
  stream_config: term(),
  sync_config: term()
}

Functions

client(client, predefined_shape)

is_queryable?(schema)