エンティティスキーマ

エンティティは、データ構造と検証ルールを記述する JSON スキーマを使用して定義されます。

基本のスキーマ構造

エンティティスキーマは、プロジェクトの entities ディレクトリ内の JSON ファイルで定義されます。デフォルトでは base44/entities/ ですが、プロジェクト構成でパスをカスタマイズできます。ファイル名がエンティティ名を決定します。例えば、Task.json は Task エンティティを作成します。エンティティスキーマのテンプレート:

{
  "name": "my_entity",
  "type": "object",
  "title": "My Entity",
  "description": "Description of what this entity represents",
  "properties": {
    "<field_name>": {
      "type": "<field_type>",
      "<option>": "<value>"
    }
  },
  "required": ["<field_name>"]
}

組み込みフィールド

すべてのエンティティレコードには、次のフィールドが自動的に含まれます。スキーマでこれらの名前のフィールドを定義しないでください。

フィールド	型	説明
`id`	string	レコードの一意識別子
`created_date`	datetime	レコードが作成された日時
`updated_date`	datetime	レコードが最後に更新された日時
`created_by`	string	レコードを作成したユーザーのメール
`created_by_id`	string	レコードを作成したユーザーの ID
`is_deleted` (internal)	boolean	ソフト削除フラグ
`deleted_date` (internal)	datetime	レコードが削除された日時
`is_sample` (internal)	boolean	レコードがサンプルデータかどうか
`entity_name` (internal)	string	エンティティタイプの名前
`app_id` (internal)	string	アプリ ID
`environment` (internal)	string	`prod` または `dev`

内部フィールドは API レスポンスで返されませんが、セキュリティルールで参照できます。

スキーマフィールド

string

エンティティの文字列識別子。

string

必須

"object" である必要があります。

string

ユーザーフレンドリーな表示名。

string

エンティティが表すものの説明。

object

必須

フィールド定義を含むオブジェクト。各フィールドには type とオプションの検証ルールがあります。

フィールドタイプ

エンティティは、保存できる異なる種類のデータを定義するさまざまなフィールドタイプをサポートしています: string、integer、number、boolean、array、object。 properties 内の各フィールドには type が必要です。型に基づいて、検証オプションを追加できます。

String フィールド

String フィールドは次のオプションをサポートします:

minLength / maxLength: 最小および最大文字数を制御します。
pattern: カスタム検証用の正規表現。
format: 事前定義された形式。サポートされる値:
- "date"
- "date-time"
- "time"
- "email"
- "uri"
- "hostname"
- "ipv4"
- "ipv6"
- "uuid"
enum: 特定の許可された値に制限します。配列として定義: ["value1", "value2", "value3"]。
default: 提供されない場合のデフォルト値。

Integer フィールド

Integer フィールドは次のオプションをサポートします:

minimum / maximum: 包含的な下限/上限を設定します。
default: 提供されない場合のデフォルト値。

Number フィールド

Number フィールドは次のオプションをサポートします:

minimum / maximum: 包含的な下限/上限を設定します。
default: 提供されない場合のデフォルト値。

Boolean フィールド

Boolean フィールドは次のオプションをサポートします:

default: 提供されない場合のデフォルト値。

Array フィールド

Array フィールドは次のオプションをサポートします:

items: 配列要素のタイプ/スキーマを定義します。
default: 提供されない場合のデフォルト配列値。

Object フィールド

Object フィールドは次のオプションをサポートします:

properties: オブジェクト内のフィールドを定義します。
required: 必須プロパティ名のリスト。

必須フィールド

提供する必要があるフィールドを指定します:

{
  "required": ["title", "email"]
}

一意性

Base44 エンティティは一意制約をサポートしていません。unique_fields のようなスキーマフォーマットに含まれないプロパティは、スキーマとともに保存されますが無視されます。

レコードの重複を避けるには、新しいレコードを作成する前にバックエンド関数で既存のレコードをチェックしてください。このようなチェックは重複の発生する可能性を狭めますが、完全には排除できません。1 人のユーザーだけが確実に成功するようにするには、同時更新のクレームパターンを使用してください。

同時更新

Base44 はレコードをロックせず、複数のレコードにまたがるトランザクションも実行しません。2 人のユーザーやプロセスが同時に同じデータを変更すると、各書き込みは個別に適用されます。このセクションでは、どの更新がアトミックか、レコードを安全にクレームする方法、複数のレコードを書き込む呼び出しで想定される動作について説明します。

レコードを安全にクレームする

タスクや予約枠など、既存のレコードを 1 人のユーザーだけがクレームできるようにするには、その単一レコードの id と、まだ満たされている必要がある条件を指定して updateMany() を呼び出します。更新は、書き込みの時点で条件がまだ一致する場合にのみ適用されます。そのため、2 人のユーザーが同時に試行しても、成功するのは 1 人だけです。自分の更新が成功したかどうかは、レスポンスの updated で確認します。

const result = await base44.entities.Task.updateMany(
  { id: taskId, status: "open" },
  { $set: { status: "claimed", claimed_by: user.email } }
);

if (result.updated === 1) {
  // This user claimed the task.
} else {
  // Someone else claimed it first, or it was no longer open.
}

書き込みの時点で条件が再チェックされるのは、クエリで単一レコードの id をプレーンな値として指定した場合のみです。$in や $or で複数の id を指定する場合を含め、それ以外のクエリでは、まず一致するレコードを見つけてから更新します。そのため、その間に変更されたレコードも更新される可能性があります。

複数のレコードを書き込む

bulkCreate()、bulkUpdate()、updateMany()、deleteMany()、upsert() はトランザクションではありません。各レコードは個別に書き込まれるため、呼び出しが途中で失敗しても、すでに書き込まれたレコードはそのまま残ります。これらの呼び出しは、再実行しても安全になるように設計してください。たとえば、すでに更新されたレコードを除外します。同じキーで upsert() を同時に呼び出すと、重複したレコードが作成されることがあります。

完全な例

完全なエンティティスキーマ:

{
  "name": "Task",
  "type": "object",
  "title": "Task",
  "description": "A task item with priority, due date, and completion status",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "description": {
      "type": "string",
      "maxLength": 1000
    },
    "priority": {
      "type": "string",
      "enum": ["low", "medium", "high"],
      "default": "medium"
    },
    "completed": {
      "type": "boolean",
      "default": false
    },
    "due_date": {
      "type": "string",
      "format": "date"
    },
    "tags": {
      "type": "array",
      "items": { "type": "string" }
    },
    "internal_notes": {
      "type": "string",
      "rls": {
        "read": {"user_condition": {"role": "admin"}},
        "write": {"user_condition": {"role": "admin"}}
      }
    }
  },
  "required": ["title"],
  "rls": {
    "create": true,
    "read": {"created_by": "{{user.email}}"},
    "update": {"created_by": "{{user.email}}"},
    "delete": {"created_by": "{{user.email}}"}
  }
}

エンティティのデプロイ

エンティティスキーマを定義した後、entities push を使用して Base44 にデプロイします。プロジェクト全体をデプロイするために deploy コマンドを実行すると、エンティティも自動的にデプロイされます。デプロイ後、SDK の entities モジュールを使用してエンティティと対話できます。スキーマ内のエンティティ名は、大文字小文字を含めて、SDK でアクセスする方法と正確に一致する必要があります。例えば、スキーマに "name": "Task" がある場合、base44.entities.Task.list() としてアクセスする必要があります。デプロイされたエンティティスキーマは、ダッシュボードの Data セクションで表示できます。

概要

クイックスタート

プロジェクト

AI 開発ツール

リソース

基本のスキーマ構造

組み込みフィールド

スキーマフィールド

フィールドタイプ

String フィールド

Integer フィールド

Number フィールド

Boolean フィールド

Array フィールド

Object フィールド

必須フィールド

一意性

同時更新

レコードを安全にクレームする

複数のレコードを書き込む

完全な例

エンティティのデプロイ

関連項目

​基本のスキーマ構造

​組み込みフィールド

​スキーマフィールド

​フィールドタイプ

​String フィールド

​Integer フィールド

​Number フィールド

​Boolean フィールド

​Array フィールド

​Object フィールド

​必須フィールド

​一意性

​同時更新

​レコードを安全にクレームする

​複数のレコードを書き込む

​完全な例

​エンティティのデプロイ

​関連項目

基本のスキーマ構造

組み込みフィールド

スキーマフィールド

フィールドタイプ

String フィールド

Integer フィールド

Number フィールド

Boolean フィールド

Array フィールド

Object フィールド

必須フィールド

一意性

同時更新

レコードを安全にクレームする

複数のレコードを書き込む

完全な例

エンティティのデプロイ

関連項目