API Reference PhoenixKitSync v#0.2.5

Copy Markdown View Source

Modules

Main context for Sync module.

Spawn async tasks that need to outlive the calling process.

Client for communicating with the Sync channel from the Receiver's LiveView.

Synchronous client for connecting to a remote DB Sync sender.

Struct representing a single database column's metadata.

Schema for DB Sync persistent connections between PhoenixKit instances.

Handles cross-site notification when creating sender connections.

Record-transformation and value-preparation helpers shared across the import paths in ConnectionNotifier.

Context module for managing DB Sync connections.

Exports data from database tables for DB Sync module.

Handles import of records from remote sender with conflict resolution.

Single translation point for every error atom the sync module emits.

The wire form of the column types Postgrex returns as a struct of its own: how the exporters write one and how the importers read it back, for the REST and the WebSocket paths alike.

Gettext backend for phoenix_kit_sync.

Creates the sync tables if they don't already exist.

Reads numbers that arrive from outside — a URL parameter, a LiveView event, a peer's WebSocket payload, an API request — where anything can turn up.

Centralized URL helpers for PhoenixKitSync admin pages.

The keyset cursor of a bulk pull: where a page starts and where the next one continues.

The record filter of a precise pull, shared by both ends of the protocol.

Route module for PhoenixKit Sync non-admin routes.

Inspects database schema for DB Sync module.

ETS-based session storage for DB Sync module.

Struct representing a database table's schema information.

Schema for DB Sync data transfers.

Context module for managing DB Sync transfers.

API controller for Sync cross-site operations.

Parameter validators for the sync REST API endpoints.

LiveView for managing DB Sync permanent connections.

Status-resolution and connection-verification helpers for the Connections LiveView.

LiveView for DB Sync transfer history.

Landing page for DB Sync module.

Receiver-side LiveView for DB Sync.

Pure formatting / parsing / counting helpers for the Receiver LiveView.

Sender-side LiveView for DB Sync.

Plug for handling DB Sync WebSocket connections.

Channel for DB Sync protocol messages.

Socket for DB Sync module.

WebSock handler for DB Sync module.

WebSocket client for Sync receiver connections.

Oban worker for background data import from DB Sync.