데이터베이스에서 TypeScript 유형 생성
하나의 명령으로 테이블을 유형으로 변환할 수 있습니다. 그런 다음 편집기는 실행하기 전에 잘못된 열이나 잘못된 값을 거부합니다.
파일 생성#
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가 포함된 로컬 스키마 스냅샷)을 읽습니다.
두 개의 테이블과 두 개의 함수가 있는 프로젝트에서는 다음이 인쇄됩니다.
[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키를 커밋하거나 클라이언트 코드에 노출하지 마세요).