Nano ID

概要

NocoBaseでは、Nano ID（Nano ID）を使用して、短いランダムな一意IDを生成できます。

Nano IDは、短縮URL、公開用番号、外部参照IDなど、短い文字列による識別が必要な場面に適しています。

デフォルトの内部主キーとして使用する場合は、Snowflake IDのほうが一般的です。可読性のある業務用番号が必要な場合は、シーケンスを選択してください。

利用シーン

Nano IDは、次のような業務シーンに適しています。

短縮URLの識別子
公開用共有ID
外部参照番号
短いランダムな一意文字列

作成と設定

データテーブルの「Configure fields」ページで「Add field」をクリックし、「Nano ID」を選択すると、Nano IDフィールドを作成できます。

20240512173225

設定	説明
Field interface	フィールドのインターフェースタイプ。Nano IDでは `nanoId` に対応し、ページ上での入力方法や表示方法を決定します。
Field display name	画面上に表示されるフィールド名。「共有ID」「公開ID」「短縮識別子」などを指定します。業務担当者が直感的に理解できる名前を推奨します。
Field name	API、リレーションフィールド、権限、ワークフローなどで内部参照するためのフィールド識別名です。作成後は通常変更せず、英字、数字、アンダースコアのみ使用でき、先頭は英字にする必要があります。
Field type	データ層におけるフィールドの型。Nano IDではデフォルトで `string` を使用します。
Default value	デフォルト値。新しいレコードを追加する際、ユーザーが入力しなかった場合に自動的に設定できます。
Validation rules	通常はシステムによって自動生成されるため、手動で検証する必要はありません。
Description	フィールドの説明。フィールドの意味、入力要件、データソース、管理担当者などを記載するのに適しています。

注意

フィールド名は、作成後にページブロック、権限、ワークフロー、APIから参照されます。後から変更すると設定の調整コストが発生するため、作成前に命名を確認してください。

フィールドの特性

Nano IDフィールドのデフォルトの動作は次のとおりです。

特性	説明
デフォルトの Field interface	`nanoId`。
デフォルトの Field type	`string`。
選択可能な Field type	`string`。
ページコンポーネント	通常は自動生成されるため、手動で入力する必要はありません。
フィルター	Nano IDによる完全一致検索に対応しています。
並べ替え	通常、業務上の並べ替えにNano IDは使用しません。
検証	通常は自動生成され、一意性が維持されます。

設定の編集

作成後、フィールド右側の「Edit」をクリックすると、Nano IDフィールドの設定を編集できます。フィールドの編集は、主にNocoBaseでの表示方法や利用方法を調整するために行います。たとえば、表示名、説明、デフォルト値、検証ルール、フィールド固有の設定などを変更できます。

フィールドがメインデータベースですでに同期されているテーブルに由来する場合、編集時には通常、フィールドマッピングを行います。これは、データベースのフィールドをNocoBaseのField typeおよびField interfaceに対応付ける作業です。

設定	編集可否	説明
Field display name	はい	画面上に表示されるフィールド名を変更します。フィールド識別名は変更されません。
Field name	いいえ	フィールド識別名は、作成後、通常は編集フォームから変更できません。
Field interface	条件付きで可	メインデータベースのフィールドまたは同期フィールドは、フィールドマッピング時に調整できます。変更すると、ページ上の入力、表示、検証方法に影響します。
Field type	条件付きで可	メインデータベースのフィールドまたは同期フィールドは、フィールドマッピング時に調整できます。変更前に、既存データを新しい型で利用できるか確認する必要があります。
Default value	はい	新しいレコードを追加する際のデフォルト値を調整します。
Validation rules	はい	フィールドの検証ルールを調整します。
Description	はい	フィールドの意味、入力要件、データソース、管理担当者などを補足します。

注意

Field typeやField interfaceの切り替えは、表示名を変更するだけの操作ではありません。フィールドの保存方式、入力コンポーネント、検証ルール、フィルター条件、ワークフロー変数の使用方法に影響します。既存データが多い場合は、あらかじめデータ形式が一致するか確認してください。

フィールドの削除

フィールド右側の「Delete」をクリックすると、Nano IDフィールドを削除できます。メインデータベースでは、複数のフィールドを選択して一括削除することもできます。

メインデータベースで作成したNano IDフィールドを削除すると、通常はデータベース内の実際の列と、その列に保存されている既存データも同時に削除されます。データベースとの同期や外部データソースからのマッピングによって作成されたフィールドを削除する場合、影響範囲は対応するデータソースとフィールドの由来によって異なります。

警告

フィールドを削除すると、ページブロック、フォーム、フィルター、権限、ワークフロー、API、インポート・エクスポート、既存データに影響する可能性があります。削除前に、そのフィールドが業務設定から参照されていないか確認してください。

ページ設定での利用

Nano IDフィールドは、公開用の短い識別子や外部参照に適しています。 20260710151321

シーン	用途
フォームブロック	通常は手動で編集せず、システムが生成します。
詳細ブロック	短い識別子を表示します。
API	レコードの公開用識別子として使用します。
外部リンク	短縮URLや共有リンクの一部として使用します。

#Nano ID

#概要

#利用シーン

#作成と設定

#フィールドの特性

#設定の編集

#フィールドの削除

#ページ設定での利用

#関連リンク