ファイルコレクション
概要
ファイルコレクションは、ファイル名、拡張子、サイズ、MIME タイプ、パス、URL、プレビューアドレス、保存先、カスタム meta などのファイルメタ情報を保存するために使用します。ファイル本体はファイルストレージエンジンに保存され、ファイルコレクションにはファイルのメタデータが保存されます。
ファイルコレクションはメインデータベースのページからのみ作成できます。外部データベース、REST API データソース、外部 NocoBase データソースではファイルコレクションを作成できません。
適用シーン
ファイルコレクションは、次のような業務シーンに適しています。
- 契約書の添付ファイル、請求書、経費精算の証憑
- 製品画像、従業員証、プロジェクト文書
- 業務レコードにアップロードするファイル、プレビューファイル、ダウンロードファイル
- ファイルのメタ情報を個別に管理する必要がある添付ファイルライブラリ
使用フロー
ファイルコレクションは通常、主業務テーブルとして直接使用するものではありません。一般的なフローは次のとおりです。
- ファイルコレクションを作成し、ファイルのタイトル、ファイル名、サイズ、タイプ、URL、保存先などのメタ情報を保存します。
- 業務テーブルにリレーションフィールドを作成し、ファイルコレクションに関連付けます。たとえば、「契約」テーブルで「契約添付ファイル」ファイルコレクションに関連付けます。
- 業務テーブルのフォームブロックにリレーションフィールドを追加し、ユーザーが業務レコードの新規作成または編集時にファイルをアップロードできるようにします。
- アップロードが完了すると、NocoBase はファイルのメタ情報をファイルコレクションに書き込み、リレーションフィールドを通じてファイルレコードを現在の業務レコードに関連付けます。
- 業務テーブルの詳細ブロック、テーブルブロック、またはリストブロックに添付ファイルフィールドを表示し、ユーザーがファイルを確認、プレビュー、ダウンロードできるようにします。
作成設定
メインデータベースで「Create collection」をクリックし、「File collection」を選択すると、ファイルコレクションを作成できます。
ファイルコレクションの作成設定は、通常のテーブルと基本的に同じです。ファイルコレクションには、アップロードしたファイルのタイトル、パス、URL、保存先、拡張情報を保存するためのファイルメタ情報フィールドがあらかじめ用意されています。
組み込みフィールド
ファイルコレクションの作成後、通常は次の組み込みフィールドが含まれます。ファイル本体はファイルストレージに保存され、ファイルコレクションにはこれらのメタ情報が保存されます。
主キーフィールド
ファイルコレクションにも、通常のテーブルと同様に主キーフィールドが必要です。添付ファイルフィールドとリレーションフィールドは、主キーを通じてファイルのメタ情報を関連付けます。
ファイルコレクションに主キーがない場合は、データテーブルの編集時に「Record unique key」を設定してください。設定しないと、添付ファイルレコードを正しく関連付けたり、プレビューしたり、編集したりできない場合があります。
リレーションの構築
業務テーブルにリレーションフィールドを作成し、ファイルコレクションに関連付けます。
ページ設定での使用
ファイルコレクションのデータは通常、添付ファイルコンポーネントによるアップロード時に自動生成されます。フォームブロック、詳細ブロック、またはリレーションブロックで使用します。
編集設定
データテーブル一覧で、ファイルコレクションの右側にある「Edit」をクリックすると、データテーブルの表示名称、分類、説明、簡易ページネーションモード、「Record unique key」などの設定を変更できます。
ファイルメタ情報フィールドは通常、アップロード処理によって自動的に書き込まれるため、url、path、storageId などのフィールドを別の業務用途に変更することは推奨しません。ファイルに関する業務情報を拡張する必要がある場合は、「ファイルタイプ」「所属フェーズ」「アーカイブ済みかどうか」などのフィールドを追加してください。
データテーブルの削除
データテーブル一覧で、ファイルコレクションの右側にある「Delete」をクリックすると、ファイルコレクションを削除できます。
ファイルコレクションを削除すると、ファイルのメタ情報レコードと関連する Collection メタデータが削除されます。削除する前に、業務テーブルの添付ファイルフィールド、リレーションフィールド、ページブロック、権限、ワークフロー、API が引き続き依存していないか確認してください。
ファイルコレクションに保存されるのはファイルのメタ情報です。ファイルコレクションのレコードを削除すると、業務レコード内の添付ファイル参照が無効になる可能性があります。ファイル本体も同時に削除されるかどうかは、ファイルストレージと業務設定によって異なります。操作前に、そのファイルが引き続き業務で使用されているか確認してください。
関連リンク
- 通常のテーブル — 共通設定とブロックの使用方法を確認
- データテーブルのフィールド — 添付ファイルフィールドとリレーションフィールドの設定を確認
- ファイルマネージャー — ファイルストレージ関連の設定を確認
- マルチスペース — スペースフィールドとスペース分離機能を確認