supabase内のテーブルを監視するコードが書けずに困っていましたが解決したので備忘録がてら記事を残しておきます。
リアルタイム監視についてのswiftコード
supabase公式ドキュメントにサンプルコードはありますが、非同期タスクの記載の仕方に慣れていないためAIを頼りながらコードを作成しました（AIすごい！）
以下のコードでリアルタイム監視することができました！
import SwiftUI
import Supabase
//supabaseクライアントの設定
let supabase = SupabaseClient(
supabaseURL: URL(string: "YOUR_SUPABASE_URL")!, //自身のURLを記述
supabaseKey: "YOUR_SUPABASE_ANON_KEY" //自身のKEYを記述
)
//Instrumentモデル
struct Instrument: Decodable, Identifiable {
let id: Int
let name: String
}
struct ContentView: View {
@State var instruments: [Instrument] = []
@State private var channel = supabase.channel("channelId")
var body: some View {
Text("プレビュー画面")
.task {
let changeStream = channel.postgresChange(AnyAction.self, schema: "public")
await channel.subscribe()
for await change in changeStream {
switch change {
case .delete(let action): print("Deleted: \(action.oldRecord)")
case .insert(let action): print("Inserted: \(action.record)")
case .update(let action): print("Updated: \(action.oldRecord) with \(action.record)")
}
}
}
}
}
#Preview {
ContentView()
}
"YOUR_SUPABASE_URL" と "YOUR_SUPABASE_ANON_KEY" は、supabaseの「Project Setting」→「DataAPI」から確認することができます。
このコードをそのまま実装すればリアルタイム機能を実装できますが、これでもできない場合はいくつか準備が不足していると思うので、以下で説明していきます。
supabase-seiftライブラリの導入
このようなエラーが出る場合は、まずライブラリをインストールする必要があります。
-
Xcodeでプロジェクトを開き、「File」→「Add Package Dependencies」を選択
-
以下のURLを検索し、「Add Package」をクリック
https://github.com/supabase/supabase-swift
3.「Add Package」をクリック
4. 「プロジェクト」→「Targets」セクションで該当のターゲットを選択」→「Build Phases」タブ→「Link Binary With Libraries」セクションで「+」ボタンをクリック
5. 「Supabase」を選択、「Add」をクリック
テーブル作成 & セキュリティ設定
今回の監視対象となるテーブルの作成、行レベルセキュリティ（RLS）の有効化、ポリシー設定を行います。
supabaseのSQL Editorを開き、以下のSQLを実行してください。
ちなみにsupabase公式ドキュメントで紹介されているものと同じSQLです。
-- テーブルを作成
create table instruments (
id bigint primary key generated always as identity,
name text not null
);
-- サンプルデータをinsert
insert into instruments (name)
values
('violin'),
('viola'),
('cello');
--行レベルセキュリティ（RLS）を有効化
alter table instruments enable row level security;
--ポリシー設定
create policy "public can read instruments"
on public.instruments
for select to anon
using (true);
レプリケーション設定
supabase公式ドキュメントから引用しますが、以下の記載があります。
By default, listening to database changes is disabled for new projects due to database performance and security concerns. You can turn it on by managing Realtime's replication.
デフォルトでは、データベースのパフォーマンスとセキュリティ上の問題から、新しいプロジェクトではデータベースの変更をリッスンする機能は無効になっています。Realtimeのレプリケーションを管理することで有効にすることができます。
よってレプリケーション機能を有効化します。
方法は以下2通りあります。
- SQLで有効化する
- コンソール画面から有効化する
どちらかお好きな方で設定してください。
SQLによる有効化
supabeseのSQL Editorから以下のSQLを実行してください。
alter publication supabase_realtime add table instruments;
supabase_realtimeというpublicationはプロジェクトを作成した時点で自動的に作成されるため、自分で作成する必要はありません
コンソール画面から有効化
1.supabaseからプロジェクトを開き、「Database」を選択
2.「Publications」→ Source列の「◯table」を選択
3. 対象テーブルのトグルをONにする
実際に監視してみる
simulatorを起動してから、テーブルに変更を加えてみます！
celloという値を持つレコードを削除すると...
Xcodeのデバッグエリアに削除されたレコードのidが表示されました！よかった！
まとめ
テーブルのリアルタイム監視を行うためには以下のような設定が必要でした。
- supabaseライブラリのインストール
- テーブルの作成 & セキュリティの設定
- レプリケーション設定
個人的には非同期処理のコードを書くことに一番苦戦しました...