Перейти к содержимому
Логотип Аурабаза
аурабаза

Генерируйте типы TypeScript из вашей базы данных.

Одна команда превращает ваши таблицы в типы. Затем ваш редактор отклоняет неправильный столбец или неправильное значение, прежде чем вы что-либо запустите.

Практическое руководство4 мин читатьУровень новичокПересмотрено 12 окт. 2026 г.

Эта страница была переведена автоматически. Английская версия является авторитетной.

Создать файл#

terminalbash
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).

В проекте с двумя таблицами и двумя функциями выводится:

text
[aurabase-gen] Types written to src/types/database.types.ts (2 table(s), 2 function(s), 0 enum(s), 0 view(s)).

Запускайте его снова при каждом изменении схемы (или передайте --check в CI, чтобы избежать сбоя схемы). Добавьте --schema <name> для схемы, отличной от public, --type-name для переименования основного типа и --numeric-as-string для сохранения numeric/decimal как string вместо number.

Используйте его с клиентом#

src/lib/aurabase.tstypescript
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. На реальном файле компилятор выдал такие результаты:

checked.tstypescript
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' })      // ок: остальные столбцы имеют значения по умолчанию

В Insert столбец со значением по умолчанию или столбцом, допускающим значение NULL, является необязательным. В Update каждый столбец является необязательным.

Типы строк для ваших компонентов#

Todo.tsxtypescript
import type { Tables, TablesInsert, TablesUpdate, Enums } from '../types/database.types'

type Todo = Tables<'todos'>             // ряд, как читать
type NewTodo = TablesInsert<'todos'>    // что принимает функция Insert()
type TodoPatch = TablesUpdate<'todos'>  // какое обновление() принимает

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 и не раскрывайте его в клиентском коде).