データベースから TypeScript 型を生成する
1 つのコマンドでテーブルを型に変換します。その後、エディターは、何かを実行する前に、間違った列または間違った値を拒否します。
ファイルを生成する#
npx @aurabase/gen --url https://my-app.aurabase.cloud --key "$AURABASE_SERVICE_ROLE_KEY" --out src/types/database.types.ts
スキーマのイントロスペクション (GET /v1/db/schema) には service_role キー (AURABASE_SERVICE_ROLE_KEY) が必要です。 anon キーを渡すと、明示的なメッセージが表示されて拒否されます。 --url および --keyがない場合、 @aurabase/gen は環境から NEXT_PUBLIC_AURABASE_URL および AURABASE_SERVICE_ROLE_KEY 、および .env、 .env.local、 .env.development (または --from-fileを使用したローカル スキーマ スナップショット) を読み取ります。
2 つのテーブルと 2 つの関数を持つプロジェクトでは、次のように出力されます。
[aurabase-gen] Types written to src/types/database.types.ts (2 table(s), 2 function(s), 0 enum(s), 0 view(s)).
スキーマが変更されるたびに再実行します (または、CI で --check を渡してスキーマ ドリフトで失敗します)。 public以外のスキーマには --schema <name> を追加し、メイン型の名前を変更するには --type-name を、 numeric/decimal を numberではなく string として保持するには --numeric-as-string を追加します。
クライアントと一緒に使用する#
import { createClient } from '@aurabase/aurabase-js'
import type { Database } from '../types/database.types'
export const aura = createClient<Database>(process.env.NEXT_PUBLIC_AURABASE_URL!, process.env.NEXT_PUBLIC_AURABASE_ANON_KEY!)
生成された型は、 Row、 Insert 、 Updateを使用して各テーブルを記述します。実際のファイルに対して、コンパイラは次の結果を返しました。
const { data } = await aura.from('todos').select('id, title, done')
const title: string | undefined = data?.[0]?.title // わかりました
const wrong: number | undefined = data?.[0]?.title // エラー: 文字列を数値に割り当てることはできません
await aura.from('todos').insert({ title: 1 }) // エラー: 数値を文字列に割り当てることはできません
await aura.from('todos').insert({ title: 'ok' }) // OK: 他の列にはデフォルトがあります
Insertでは、デフォルトの列または null 許容列を含む列はオプションです。 Updateでは、すべての列はオプションです。
コンポーネントの行タイプ#
import type { Tables, TablesInsert, TablesUpdate, Enums } from '../types/database.types'
type Todo = Tables<'todos'> // 読み取られた行
type NewTodo = TablesInsert<'todos'> // insert() が受け入れるもの
type TodoPatch = TablesUpdate<'todos'> // update() が受け入れるもの
Enums<'name'> はデータベース列挙型の値を与えます。
チェックされる内容#
- 生成されたファイルにないテーブルは拒否されません。
aura.from('anything')は引き続きコンパイルされ、その行は型指定されません。 - 関数は、型指定された引数と戻り値を持つ
Functionsの下に表示されます。add(a int, b int) returns intはArgs: { a: number; b: number }およびReturns: numberを提供し、RETURNS TABLE (content text, dist float8)関数はReturns: { content: string; dist: number }[]を提供します。匿名複合型を返す関数は、依然としてRecord<string, unknown>として表示されます。 - フィルター、
insert()およびupdate()ペイロード、列挙型、およびリレーションシップの埋め込みがチェックされます。select('a, b')文字列内の列リストは結果を入力するために使用されますが、そこにある名前のスペルミスは実行時にのみ検出されます (COLUMN_NOT_FOUND、「おそらく…」というヒントが表示されます)。 - Studio の タイプの ボタンと
npx @aurabase/genは、同じファイルを生成します。 - ファイルには、生成時のスキーマが反映されます。後で追加された列は、ツールを再度実行するまでタイプには認識されません。
- スキーマのイントロスペクションには
AURABASE_SERVICE_ROLE_KEYが必要です (ローカルまたは CI で実行します。service_roleキーをコミットしたり、クライアント コードで公開したりしないでください)。