メインコンテンツへスキップ

概要

pullコマンドは、NotCMSワークスペースへ登録されたデータベースから、設定済みの TypeScriptスキーマを生成または更新します。
最初のpullはinitが自動で実行します。データベースまたはプロパティを変更した後に、 この単独コマンドを実行してください。

実行内容

  1. NOTCMS_SECRET_KEYとNOTCMS_WORKSPACE_IDを読み込み
  2. notcms.config.jsonからスキーマの出力先を読み込み
  3. NotCMSから現在のワークスペーススキーマを取得
  4. 設定されたスキーマmoduleとncクライアントを生成
  5. 最初のデータベース用クエリを表示
notcms.config.jsonがなければ、スキーマはsrc/notcms/schema.tsに書き出されます。 ファイルがあってもJSONとして読めない、またはschemaの文字列がない場合は、 既定の出力先に書き出さずにエラーで止まります。

オプション

--checkは生成ファイルが存在しない、または古い場合に終了コード1を返すため、 CI/CDで利用できます。

例

スキーマを更新

独自の環境ファイルから認証情報を読み込む

ファイルを書き込まず確認

生成されるスキーマ

型付きスキーマと、すぐ利用できるクライアントの両方を生成します:
後から更新するためのpackage scriptも追加できます:

スキーマ変更の概要

通常のpullは以前に生成されたスキーマと比較し、データベースの追加・削除、IDの変更、プロパティの追加・削除・型変更を表示します。ファイルがない場合や手動編集で対応外の形式になった場合は比較を省略し、既存スキーマを実行することはありません。--checkはファイルを書き換えません。最新の場合は概要を省略し、未更新の場合は意味上の差分を表示します。 pull --check が未更新を検出した場合も、書き込まずに意味上の差分を表示します。初回取得と比較不能な既存ファイルは別々に案内します。比較時にローカルのモジュールは実行しません。

選択肢の型

CLIは ?include=options を自動で指定して選択肢を取得します。旧CLIにはoptionsを含まないスキーマを返すため、生成したコードを旧SDKでも引き続き型検査できます。 データベースごとの任意フィールド options に、select・status・multi_select の選択肢名を保持します。as const satisfies Schema により、たとえば options: { language: ["en", "ja"] } のselect/statusは "en" | "ja" | null、multi-selectは ("en" | "ja")[] | null になります。where の条件にも同じ選択肢が適用されます。 取得済みの空配列はselect/statusが null、multi-selectが never[] | null になります。options のない旧スキーマは従来の string | null/string[] | null を維持します。APIはメタデータ取得までoptionsを省略し、通常のDB同期またはサービス側のバックフィルで補完します。 Notionで選択肢を変更した後は、DBを同期してから notcms pull を再実行してください。選択肢の追加・削除やメタデータの取得状態の変化も差分に表示します。型はpull時点の内容を表し、SDKは実行時の未知の値を変換・破棄しません。 CI でスキーマを確認する