Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ilyama.golain.io/llms.txt

Use this file to discover all available pages before exploring further.

Edge SQLite sync (also called edge replication) mirrors data from a SQLite database on your device into Golain cloud storage. Changes are captured on the device, sent over MQTT, governed on the server, and materialized into queryable mirror tables or telemetry series. This is not a file-level SQLite backup. The cloud stores governed, typed projections — not a copy of your .db file.

Who this is for

RoleStart here
Fleet operator / platform adminHow it worksSchema review workflow
Edge engineer shipping OmegaOmega setupConfiguration
Integrator building a custom agentWire protocol reference
SRE / on-callTroubleshooting

At a glance

Core concepts

Lineage

One sync relationship per device + SQLite table. Tracks active/paused status and materialization health.

Staging

Rows held in cloud storage while schema is under review or lineage is paused — not lost.

Schema review

Human approval when a table’s schema is new or changed. You decide which columns mirror to the cloud.

Materialization

Approved rows land in edge_mirror_* tables or telemetry — queryable from the platform.

Components

PieceRepositoryRole
Omega sqlite-replication modulegolain-io/omegaTriggers, journal, MQTT publish, pause/resume on device
MQTT brokergolain-io/ilyamamTLS auth, topic ACL, ingress to worker queue
Integration workerilyamaIngest, classify schema, stage, review RPC, replay, mirror DDL
HTTP API + platform-tuiilyamaOperator governance and inspection
Reference client: ilyama-edge (omega/clients/ilyama-edge.yaml).

Typical first-time flow

  1. Register device in console or platform-tui — note device name (used as MQTT client ID / topic segment).
  2. Provision mTLS certs for the device (cert worker or JITR — see provisioning checklist).
  3. Configure Omega with OMEGA_SOURCE_DB_PATH, broker URL, OMEGA_ROOT_TOPIC, TLS paths.
  4. Start Omega — module installs triggers on user tables; first batches arrive in cloud.
  5. Approve schema — default policy queues review on first sight of a table; claim + approve in Edge Sync.
  6. Query data — mirror rows via API/TUI or QueryScript after materialization.
With default governance policy, the first batch from a new table triggers a schema review and the lineage enters paused until you approve. The device can keep sending; the cloud stages rows server-side during review.

Documentation map

Concepts

Edge agent

Operations

Wire protocol (integrators)

Normative spec in source: ilyama edge-client-guide.

Current limitations

Document these when planning production rollouts:
AreaLimitation
Omega telemetry batchessync/telemetry/batch flush is not fully implemented — use strategy: rows for time-series-shaped tables
Bootstrap snapshotsnapshot_on_first_run flag exists but is not implemented — only mutations after Omega starts replicate
Secondary upload flowPresigned URL bootstrap/spill path specified but not implemented in Omega
platform-tui approve shortcutDev TUI approve mirrors a single column — use HTTP API for full column_actions in production
Authz on mirror readsProduct-level authorized reads for mirror tables still evolving
See Troubleshooting for operational workarounds.