Kotlin: Introduction

KizunaSyncClient is the typed Kotlin app client over the UniFFI engine in kizunasync-ffi, and the native peer of createKizunaSync in JavaScript. Reads answer from a local SQLite file, and writes land there first, wait in a durable outbox, and settle against Supabase on a sync run. Every method except from(table) is a suspending function on Dispatchers.IO, so a call from the main thread never blocks the interface.

Version#

kizunasync-ffi 0.2.6-alpha.3 (Alpha). Maven Central com.kizunasync:kizunasync, Kotlin package com.kizunasync.kizunasync. See Installing.

What this reference covers#

• The shortest path through the client is Initializing, then the Host scheduler, which syncs after every write, then Insert data.
• Local reads and writes: Fetch data, Insert data, Update data, Delete data, Write with filters, Using filters, and Using transforms.
• Sync controls: Sync, Pull once, Push once, Set bucket, Checkpoint, Outbox depth, and Reset.
• The rest of the surface: Set access token, List rejections, Dismiss a rejection, List overwrites, Dismiss an overwrite, Subscribe to events, the attachment methods from Attach a file to Vacuum attachments, including Retry, Cancel, and Remove an attachment, the Host scheduler, Inspect and Inspector, Dispose, and Types.
• Kotlin has no hooks. useQuery and useSyncStatus belong to the JavaScript bindings; an Android app pairs Subscribe to events with a Flow, and reads loop state from health() / onHealth on Host scheduler. from(table) is the fluent peer of JavaScript kizunasync.from.

What Supabase covers#

Concern	Use
Sign-in, sessions, and token refresh	signInWith and refreshSession, then pass the token to Set access token
Row Level Security policies	Row Level Security, which judges every mutation a push carries
Realtime channels behind the wake-up doorbell	subscribe from the app, calling wake on the Host scheduler
Storage objects outside the attachment path	upload

Related reference#

• Installing
• Initializing
• Swift: Introduction
• JavaScript: Introduction