
# 設定

必要なプロパティは二つだけです。プロジェクトのアドレスと anon キーです。それ以外にはすべてデフォルトがあります。このページは、すべての `spring.supabase.*` キーを一覧にします。

## 使う理由

Supabase のプロジェクトのキーは、呼び出し元に何ができるかを決めます。そのため、それぞれをどこに書くかが重要です。anon キーは公開してよいものですが、サービスロールキーとデータベースのパスワードはそうではありません。プロパティはそれらを設定の中に置きます。サーバーはそこで環境変数から値を取り、秘密のキーが Flutter アプリに同梱されるとスターターが警告します。

## 例

```yaml
# lib/resources/application.yml
spring:
  supabase:
    url: https://abcd.supabase.co
    anon-key: ${SUPABASE_ANON_KEY}
    service-role-key: ${SUPABASE_SERVICE_ROLE_KEY}   # a server only
    db:
      url: ${SUPABASE_DB_URL}                         # optional: SQL instead of the REST API
      rls: user
    auth:
      redirect-urls:
        - com.example.app://login
    cache:
      shared: [catalog]
```

```properties
# lib/resources/application.properties
spring.supabase.url=https://abcd.supabase.co
spring.supabase.anon-key=${SUPABASE_ANON_KEY}
spring.supabase.service-role-key=${SUPABASE_SERVICE_ROLE_KEY}
spring.supabase.db.url=${SUPABASE_DB_URL}
spring.supabase.db.rls=user
spring.supabase.auth.redirect-urls[0]=com.example.app://login
spring.supabase.cache.shared=catalog
```

## プロジェクト

| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
| `spring.supabase.url` | `String` | なし | プロジェクトのアドレス。`https://<ref>.supabase.co`、またはローカルのスタックの `http://127.0.0.1:54321`。`http` か `https` で、末尾のスラッシュ、ユーザー、クエリ、フラグメントは付けない。それ以外は起動を失敗させる。すべてのサービスはこの下で呼び出され (`/rest/v1`、`/auth/v1`、`/storage/v1`、`/functions/v1`、`/realtime/v1`)、キーやトークンはここにしか送られない。 |
| `spring.supabase.anon-key` | `String` | なし | anon (publishable) キー。すべての呼び出しで `apikey` として送られ、誰もサインインしていない間は Bearer トークンにもなる。公開してよいキー。これがないと、呼び出しはプロパティ名を示す `StateError` で失敗する。 |
| `spring.supabase.service-role-key` | `String` | なし | サービスロール (secret) キー。[`asServiceRole`](credentials.md) の中でだけ使われる。行レベルセキュリティを通過するので、サーバーに置くこと。 |
| `spring.supabase.connect-timeout` | `Duration` | `10s` | Realtime の接続を開くのにかけてよい時間。WebSocket クライアント `supabase-realtime` (または `default`) が自身の `connect-timeout` を設定していれば、そちらが使われる。Realtime だけのものです。HTTP の呼び出しはアプリケーションの `HttpTransport` を通り、その接続タイムアウトが適用され、全体は `timeout` が制限します。 |
| `spring.supabase.timeout` | `Duration` | `30s` | 一つの呼び出しにかけてよい時間 (応答のボディを含む)。Storage のダウンロードのボディは、これで制限されない。 |

## データベース: spring.supabase.db

| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
| `spring.supabase.db.url` | `String` | なし | プロジェクトの PostgreSQL のアドレス (`postgresql://postgres:<password>@db.<ref>.supabase.co:5432/postgres`、またはプーラーのアドレス)。設定すると、リポジトリはその上で SQL を使う。設定しないと、プロジェクトの REST API を使う。[データ](data.md) を参照。 |
| `spring.supabase.db.rls` | `off`、`user` | `off` | SQL を誰として実行するか。`off`: `db.url` のユーザー (通常は `postgres` で、行レベルセキュリティを通過する)。`user`: 現在のユーザー。ロール `authenticated` (または `anon`) とトークンのクレームが付く。 |
| `spring.supabase.db.schema` | `String` | API のデフォルト (`public`) | REST API が読み書きするスキーマ (PostgREST の `Accept-Profile` と `Content-Profile`)。 |
| `spring.supabase.db.max-rows` | `int` | `1000` | REST API が 1 回の応答で返す最大行数 (プロジェクトの "Max rows")。その長さの応答は、id 順の追加の呼び出しで続きを読み取ります。プロジェクト側の値を変更した場合は、同じ値を設定してください。 |

## Auth: spring.supabase.auth

| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
| `spring.supabase.auth.enabled` | `bool` | `true` | スターターが Supabase Auth を Spring Security に組み込むかどうか。サーバーでは[リソースサーバーのデフォルト](security.md)、そして `supabaseAuth` と `supabaseAuthAdmin` (サーバーのみ) の Bean ([サインイン](auth.md))。 |
| `spring.supabase.auth.redirect-urls` | `List<String>` | 空 | プロバイダー経由のログイン、マジックリンク、パスワードのリセットが戻ってきてよいアドレス。最初のものがデフォルト。それ以外の `redirectTo` は、リクエストを送る前に拒否される。 |
| `spring.supabase.auth.issuer` | `String` | `<url>/auth/v1` | プロジェクトのトークンの発行者 (`iss`)。 |
| `spring.supabase.auth.jwt-secret` | `String` | なし | まだ HS256 でトークンに署名しているプロジェクトの JWT シークレット (レガシーのシークレット)。サーバー専用。これがあれば、任意のユーザーのトークンを偽造できる。 |
| `spring.supabase.auth.persist-session` | `bool` | `true` | セッションを再起動をまたいで保持するかどうか。アプリケーションの `SecretStore` に保存される (なければメモリ上)。 |
| `spring.supabase.auth.auto-refresh` | `bool` | `true` | アクセストークンを、期限が切れる前にタイマーで更新するかどうか。無効にすると、次の呼び出しが必要としたときに更新される。 |
| `spring.supabase.auth.refresh-margin` | `Duration` | `30s` | 期限のどれだけ前から、アクセストークンを期限切れとみなすか。 |

## Realtime、Storage、関数、キャッシュ

| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
| `spring.supabase.realtime.heartbeat-interval` | `Duration` | `25s` | Realtime の接続が生きていることを伝える間隔。 |
| `spring.supabase.realtime.timeout` | `Duration` | `10s` | 参加やメッセージが応答を待つ時間。 |
| `spring.supabase.realtime.max-message-size` | `DataSize` | `4MB` | Realtime から読む最大のメッセージ (行の変更は 1 MB、ブロードキャストは 3 MB になりうる)。これより大きいと接続を閉じる。 |
| `spring.supabase.storage.signed-url-expiry` | `Duration` | `1h` | 呼び出しが指定しないときの、署名付き URL の有効期間。 |
| `spring.supabase.functions.region` | `String` | なし | Edge Functions を実行するリージョン (`x-region` ヘッダー)。設定しなければ最も近いリージョン。 |
| `spring.supabase.functions.timeout` | `Duration` | `spring.supabase.timeout` | 関数にかけてよい時間。 |
| `spring.supabase.cache.shared` | `List<String>` | 空 | エントリーがすべてのユーザーで同じキャッシュ。それ以外のキャッシュは、呼び出し元ごとにエントリーを分ける。[キャッシュ](cache.md) を参照。 |

## 他のスターターの設定

スターターの二つの部分は他のスターターのクライアントで、その設定も受け取ります。

| 部分 | クライアント名 | キー | 備考 |
|---|---|---|---|
| Realtime | `supabase-realtime` | `spring.websocket.client.config.supabase-realtime.*`: `reconnect.*`、`connect-timeout`、`max-text-message-size`、`phoenix.heartbeat-interval`、`phoenix.push-timeout`、`phoenix.vsn` | ここで設定したものが `spring.supabase.realtime.*` より優先される。`url` は読まれない。アドレスは常にプロジェクトのもの。 |
| Edge Functions | `supabase-functions` (または `@EdgeFunctions(name:)`) | `spring.feign.client.config.supabase-functions.*` | `follow-redirects` は読まれない。このクライアントはリダイレクトに従わない。 |

[WebSocket スターターのすべてのプロパティ](../spring-boot-starter-websocket/properties.md) と [Feign スターターのすべてのプロパティ](../spring-boot-starter-feign/properties.md) を参照してください。

## スターターが自分で設定するもの

スターターは他のスターターにデフォルトを与えます。優先順位が最も低いプロパティソースなので、アプリケーションが自分で設定したものが優先されます。

| 条件 | デフォルト |
|---|---|
| `spring.supabase.db.url` が設定されている | `spring.datasource.url=${spring.supabase.db.url}` |
| `spring.supabase.url` が設定されていて、`spring.supabase.db.url` も `spring.datasource.url` もない | `spring.data.store=supabase` |
| サーバーで、`spring.supabase.url` が設定されていて、`auth.enabled` が `false` でない | `spring.security.oauth2.resourceserver.jwt.*`。[サーバーのセキュリティ](security.md) に一覧があります |

## 値の書き方

- **期間:** `500ms`、`5s`、`1m`、ISO 8601 (`PT5S`)、またはミリ秒。[Durations](../spring-core-dart/conversion/durations.md) を参照してください。
- **データサイズ:** `512B`、`8KB`、`4MB`、またはバイト。[データサイズ](../spring-core-dart/conversion/data-size.md) を参照してください。

## Spring (Java) との対応

Spring には Supabase のサポートがありません。キーはこのプロジェクト独自のものです。型は `SupabaseProperties` で、`@ConfigurationProperties('spring.supabase')` の Bean です。

## 関連項目

- [誰として呼び出すか](credentials.md)
- [データ](data.md)
- [サーバーのセキュリティ](security.md)
