schema — スキーマ定義

orizm.config.ts のスキーマをサーバーに適用したり、定義を参照・検証したりします。スキーマの書き方はスキーマを参照してください。

push / list / get は認証とプロジェクトコンテキストが必要です。validate / erd はローカルで完結するため、どちらも必要ありません。

`orizm schema push`

orizm.config.ts を読み込んで、スキーマをプロジェクトに適用します。


orizm schema push [<config-file>] [--dry-run] [--yes]

引数

引数	説明
`<config-file>`	設定ファイルのパス。省略時は `./orizm.config.ts`。

オプション

オプション	説明
`--dry-run`	適用せず、変更内容だけを表示します。
`--yes`	確認プロンプトをスキップして適用します（CI 向け）。

適用前には変更内容が表示されます。--dry-run でも --yes でもないときは、ターミナルで確認プロンプトを出し、承認したときだけ適用します。非対話環境では --yes が必要です。変更が無いときは何もしません。


# 変更内容を確認する
orizm schema push --dry-run
 
# 確認なしで適用する（CI 向け）
orizm schema push --yes

スキーマ定義のバージョン一覧を表示します。


orizm schema list [--status <status>] [--limit <n>] [--offset <n>]

オプション

オプション	説明
`--status <status>`	`pending` / `failed` / `success` で絞り込みます（複数指定可）。
`--limit <n>`	取得件数（`50` / `100` / `200`）。既定は `50`。
`--offset <n>`	ページネーションのオフセット。既定は `0`。


orizm schema list --status success --limit 100

特定のバージョンのスキーマ定義を表示します。


orizm schema get <definition-id>

引数

引数	説明
`<definition-id>`	スキーマ定義の数値 ID。

orizm.config.ts をローカルで検証します。サーバーへの通信は行いません。


orizm schema validate [<config-file>]

引数

引数	説明
`<config-file>`	設定ファイルのパス。省略時は `./orizm.config.ts`。

orizm.config.ts から ERD（Mermaid 形式）を生成します。サーバーへの通信は行いません。


orizm schema erd [<config-file>] [--output <path>]

引数

引数	説明
`<config-file>`	設定ファイルのパス。省略時は `./orizm.config.ts`。

オプション

オプション	説明
`--output <path>`, `-o`	出力先ファイル。省略時は標準出力に書き出します。