JSON
はじめに
NocoBase では、JSON（JSON） を使用して構造化データまたは半構造化データを保存します。
JSON フィールドは、外部 API のレスポンスの一部、拡張設定、動的な属性など、構造が固定されていないデータの保存に適しています。柔軟である一方、通常のフィールドに比べて、フィルタリング、検証、表示は容易ではありません。
フィールド構造が安定している場合は、ページ設定、権限、フィルタリング、ワークフローで利用しやすいように、明確なフィールドへ分割することをおすすめします。
適用シーン
JSON は次のような業務シーンに適しています。
- 外部 API の生レスポンス
- 動的な拡張属性
- 複雑な設定オブジェクト
- 構造化して分割できないデータの一時保存
作成設定
データテーブルの「Configure fields」ページで「Add field」をクリックし、「JSON」を選択すると、JSON フィールドを作成できます。
フィールド名は、作成後にページブロック、権限、ワークフロー、API から参照されます。作成前に命名を確認し、後からの変更による設定調整の負担を避けてください。
フィールドの特徴
JSON フィールドのデフォルトの動作は次のとおりです。
編集設定
作成後、フィールド右側の「Edit」をクリックすると、JSON フィールドの設定を編集できます。フィールドの編集では主に、表示名、説明、デフォルト値、バリデーションルール、フィールド固有の設定など、NocoBase におけるフィールドの表示方法や使用方法を調整します。
メインデータベースですでに同期されているテーブルのフィールドの場合、編集時には通常、フィールドマッピングを行います。つまり、データベースのフィールドを NocoBase の Field type と Field interface にマッピングします。
Field type や Field interface の切り替えは、単に表示名を変更することとは異なります。フィールドの保存方法、入力コンポーネント、バリデーションルール、フィルタリング条件、ワークフロー変数の使用方法に影響します。既存データが多い場合は、事前にデータ形式が適合するか確認してください。
フィールドの削除
フィールド右側の「Delete」をクリックすると、JSON フィールドを削除できます。メインデータベースでは、複数のフィールドを選択して一括削除することもできます。
メインデータベースで新規作成した JSON フィールドを削除すると、通常はデータベース内の実際の列と、その列に保存されている既存データも同時に削除されます。データベースから同期されたフィールドや外部データソースからマッピングされたフィールドを削除した場合の影響範囲は、対応するデータソースとフィールドの取得元によって異なります。
フィールドを削除すると、ページブロック、フォーム、フィルタリング、権限、ワークフロー、API、インポート・エクスポート、既存データに影響する可能性があります。削除前に、そのフィールドが業務設定で参照されていないか確認してください。
ページ設定での使用
JSON フィールドは、連携や拡張設定のシーンに適しています。
