運用中サイトの項目を追加・変更する
初期設定のseedと運用中のデータベースを区別し、既存の記事を保ちながら新しい入力欄を追加する流れを学びます。
目次
seedを直したのに、入力欄が増えない理由
運用中のサイトでは、seedを書き換えただけでは入力欄は増えません。現在の入力欄の定義はデータベースに保存されているため、管理画面やコマンドから変更する必要があります。
seedは、新しいサイトを初期設定するときに使う定義です。今あるサイトの定義を変更したあとで、新規サイト用のseedにも同じ変更を加えます。
ここでいうスキーマは、記事の入れ物、入力欄、分類などの構造のことです。記事本文を書き換える操作とは分けて扱います。
例:「ひとこと紹介」を追加する
「週末ノート」の記事に、任意入力のsubtitleを追加するとします。任意入力にするのは、既存の記事にはまだ値がなくても、そのまま扱えるようにするためです。
まず変更対象が自分のパソコンで動かすローカルサイトなのか、公開サイトなのかを確認し、復元に必要なバックアップを用意します。公開サイトなら、別の検証環境で同じ変更を試します。
管理画面のContent Typesでpostsを開き、新しい文字列の欄を追加します。識別名をsubtitle、表示名を「ひとこと紹介」とし、必須にはしません。変更は現在のコンテンツ定義に反映されるため、既存記事を開いて欄が増えたか確認します。
CLIで同じ変更をする場合
ここからの入力には、VS Codeのターミナルを使います。Windowsではコマンドプロンプトを選んでください。入力画面の開き方
CLIは、コマンド入力画面に文字を入力して操作する道具です。管理画面とCLIの両方で同じ欄を重ねて追加する必要はありません。以下はローカルURLがhttp://localhost:4321の場合の代替手順です。
サイトを起動したコマンド入力画面は動かしたまま、VS Codeでもう一つコマンド入力画面を開きます。weekend-note が現在地であることを確認してから、起動中のサイトにログインします。
npx emdash login --url http://localhost:4321ブラウザーの認証案内を完了したら、現在の定義を確認し、まだない欄を追加します。
npx emdash schema get posts --url http://localhost:4321
npx emdash schema add-field posts subtitle --type string --label "ひとこと紹介" --url http://localhost:4321
npx emdash types --url http://localhost:4321最後のtypesは、入力欄の名前や値の種類をコードエディターなどに伝える「型」の情報を作り直します。記事データは移し替えません。コマンドは一つずつ実行し、エラーが出たらそこで止めて確認します。追加命令は、何度実行しても同じ結果になるとは限りません。
表示側は空欄にも対応する
入力欄を増やしても、テーマの表示は自動では増えません。記事詳細でpostを取得している場合、タイトルの近くに次のような表示を追加できます。
{post.data.subtitle && <p>{post.data.subtitle}</p>}値があるときだけ段落を出すので、まだ書いていない記事に空の説明を表示せずに済みます。保存しただけで読者向け表示が変わるかは公開状態によるため、変更した記事を公開して確認します。
新規作成用のseedも揃える
現在の変更が確認できたら、プロジェクトが使っているseedにも同じ欄を加えます。EmDashは.emdash/seed.json、package.jsonのemdash.seed、seed/seed.jsonなどを所定の順序で探します。別のseedを編集していないか確認してください。
seedのposts定義にあるfields配列へ入れる1件の例です。
{ "slug": "subtitle", "label": "ひとこと紹介", "type": "string" }既存の欄を消したり、ファイル全体をこの1行に置き換えたりしません。空の検証用データベースから起動した場合にも同じ入力欄になることまで確認すると、次の環境を作るときの食い違いを減らせます。
削除・名前変更は、追加とは違う
フィールド(入力欄)を削除すると、その欄に保存した値も失われます。「新しい名前の欄を追加して、古い欄を削除する」だけでは、値は引き継がれません。名前変更のつもりでも、実際には移し替える処理が必要な場合があります。
削除する場合は、その値を使わないテーマへ先に変更し、データの保存と復元を確認したうえで、定義を削除します。逆に任意欄の追加は、定義を先に追加してから、それを使うコードを配置する順番が基本です。
EmDash本体の更新に伴う内部テーブルの変更と、このコンテンツ定義の変更は別です。本体の更新だけで、あなたのサイトのsubtitleが自動追加されることはありません。
確認対象は、既存記事の本文・URL・公開状態、新しい入力欄、読者向け表示、生成した型、新規環境の初期状態です。公式のスキーマ変更ガイド(別タブで開く)には、Cloudflare D1で検証環境を用意する流れもあります。