High-level SpacetimeDB client that ties Connection, ClientCache, and Schema together.

Usage

defmodule MyApp.SpaceClient do
  use Spacetimedbex.Client

  def config do
    %{
      host: "localhost:3000",
      database: "my_db",
      subscriptions: ["SELECT * FROM users", "SELECT * FROM messages"]
    }
  end

  def on_connect(identity, _conn_id, token, state) do
    IO.puts("Connected with identity: #{inspect(identity)}")
    {:ok, Map.put(state, :token, token)}
  end

  def on_insert("users", row, state) do
    IO.puts("New user: #{inspect(row)}")
    {:ok, state}
  end
end

# Start it
{:ok, pid} = Spacetimedbex.Client.start_link(MyApp.SpaceClient, %{})

# Call a reducer
Spacetimedbex.Client.call_reducer(pid, "create_user", %{"name" => "Alice", "age" => 30})

# Query the cache
Spacetimedbex.Client.get_all(pid, "users")

Callbacks

All callbacks are optional except config/0.

• config() — returns connection configuration map
• on_connect(identity, connection_id, token, state) — called on initial connection
• on_subscribe_applied(table_name, rows, state) — called per table when subscription data arrives
• on_insert(table_name, row, state) — called per inserted row
• on_delete(table_name, row, state) — called per deleted row
• on_update(table_name, old_row, new_row, state) — called when a row with the same PK is deleted then inserted (row replacement)
• on_transaction(changes, state) — called with full transaction; return {:ok, state, :skip_row_callbacks} to suppress per-row callbacks
• on_reducer_result(request_id, result, state) — called when a reducer completes
• on_unsubscribe_applied(query_set_id, rows, state) — called when an unsubscribe completes
• on_query_result(request_id, result, state) — called with one-off query results
• on_disconnect(reason, state) — called on disconnection