title: 快速开始 order: 1

快速开始

安装

pnpm add @yydb/iris

Node 应用还需要匹配平台的 optional N-API 包（由 @yydb/iris/node loader 解析）：

@yydb/iris-win32-x64
@yydb/iris-linux-x64
@yydb/iris-unknown-wasm32   # browser WASM asset

Import 路径

import type { IrisRuntime } from "@yydb/iris/types";

// 浏览器 / Worker — 默认入口
import { createIris, initIris } from "@yydb/iris";

// Node / SSR / CLI — 必须显式子路径
import { createIris } from "@yydb/iris/node";

禁止在共享入口写 typeof window 分支动态 import； bundler 会把 N-API 与 WASM 打进同一依赖图。

CLI

Node 宿主提供 iris CLI（与 Rust iris-tools 同品牌）：

pnpm exec iris --help

当前 TypeScript 宿主 CLI 仍为 skeleton；完整语义命令由 Rust core + N-API 绑定提供。

Schema

在仓库中维护 schemas/**/*.iris，用 iris.von 声明 datasource 与 generate 输出。示例见 circle-farm 的 farm-database crate。

与 sql-studio-orm 的关系

@yydb/sql-studio-orm 与 Iris 是平行产品，不是上下层叠。Iris 只走 VOS / .iris，不路由进 SQL query AST。