uip df entities

「uip df entities」の構文とオプション - Data Fabric のエンティティ スキーマを参照して変更します。

uip df entities Data Fabric のエンティティ スキーマを参照して変更します。エンティティは型指定されたデータ モデルです。名前付きフィールドと型を持つ行の図形です。動詞は、発見 (list、 get)、作成 (create、 update)、および削除 (delete) を対象としています。レコードレベルの操作は uip df recordsで稼働中です。

概要

uip df entities list [--native-only] [--folder-key <key> | --include-folders]
uip df entities get <id> [--folder-key <key>]
uip df entities create <name> (-f <path> | --body <json>) [--folder-key <key>]
uip df entities update <id> (-f <path> | --body <json>) [-y --reason <text>] [--folder-key <key>]
uip df entities delete <id> -y --reason <text> [--folder-key <key>]

動詞

動詞	目的
list	エンティティのリストを取得します。既定値はテナント レベルのエンティティです。スコープを 1 つのフォルダーに --folder-key すると、すべてのフォルダーのエンティティ --include-folders テナント レベルのエンティティが含まれます。
get	1 つのエンティティのスキーマ (すべてのフィールドを含む) を返します。
create	JSON 定義から新しいエンティティを作成します。
update	エンティティのメタデータまたはスキーマの更新 — フィールドの追加、フィールドのメタデータの更新、またはフィールドの削除を行います (破壊的、 -y/--reasonが必要)。
delete	エンティティを完全に削除する (破壊的、 -y/--reasonが必要)。

--folder-key、--native-only、--include-folders

--folder-key <key> (フォルダー GUID) は、動詞のスコープをテナントではなくフォルダー レベルのエンティティに設定します。このグループのすべての動詞で受け入れられます。listでは、--include-folders と相互に排他的です (テナント レベルのエンティティを、すべてのフォルダーのエンティティとともに 1 回の呼び出しで一覧表示します)。--native-only ( list のみ) では、フェデレーション エンティティ (外部コネクタ接続 (空ではない externalFields 配列で識別される) によってサポートされるエンティティがフィルター処理されて除外されます。

uip df entities list

Data Fabric エンティティのリストを表示します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--native-only	フラグ	無効	ネイティブ エンティティのみを表示する外部接続を持つフェデレーション エンティティを除外します。
—	--folder-key	キー	—	フォルダー キー (GUID) - コンポーネントのスコープを特定のフォルダーに設定します。--include-foldersと相互に排他的です。
—	--include-folders	フラグ	無効	テナント レベルのエンティティと、表示されているすべてのフォルダーのエンティティを一覧表示します。--folder-keyと相互に排他的です。

例

uip df entities list --native-only

uip df entities list --folder-key f1000000-0000-0000-0000-000000000001

データシェイプ(--output json)

{
  "Code": "EntityList",
  "Data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "Invoice",
      "displayName": "Invoice",
      "entityType": "Standard",
      "description": "Invoice records",
      "folderId": "f1000000-0000-0000-0000-000000000001",
      "isRbacEnabled": false,
      "fields": [
        { "id": "f1000000-0000-0000-0000-000000000001", "name": "amount" }
      ],
      "externalFields": []
    }
  ]
}

重要:

ここでData行は、キャメルケースの生のSDKオブジェクトです—以下のgetの応答とは異なり、listフィールド名をパスカルケースに変更したり、ペイロードを再形成したりしません。各行の folderId は、そのエンティティを対象とするフォローアップ コマンドで --folder-key として渡す値です。

uip df entities get

すべてのフィールドを含む単一のエンティティのスキーマを返します。

引数

名前	Required	目的
<id>	○	エンティティ ID (UUID)。[ entities list] で検索します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--folder-key	キー	—	エンティティを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のエンティティの場合)。

例

uip df entities get a1b2c3d4-0000-0000-0000-000000000001

データシェイプ(--output json)

{
  "Code": "EntitySchema",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Invoice",
    "DisplayName": "Invoice",
    "EntityType": "Standard",
    "Description": "Invoice records",
    "IsRbacEnabled": false,
    "Fields": [
      {
        "Id": "f1000000-0000-0000-0000-000000000002",
        "Name": "amount",
        "DisplayName": "Amount",
        "FieldDataType": {
          "Name": "DECIMAL",
          "DecimalPrecision": 2,
          "MinValue": 0,
          "MaxValue": 999999
        },
        "IsRequired": true,
        "IsUnique": false,
        "IsEncrypted": false,
        "IsRbacEnabled": false,
        "IsPrimaryKey": false,
        "IsSystemField": false
      }
    ]
  }
}

listとは異なり、この応答はパスカルケースです。フィールドの型名とその制約 (型に応じて 、 MinValue、 MaxValue、 LengthLimitなど) は、フィールドのフラット プロパティとしてではなく、 の下に入れ子DecimalPrecisionFieldDataType存在します。

uip df entities create

新しいエンティティを作成します。エンティティ名は文字で始まり、文字、数字、アンダースコアのみを含める必要があります。定義をインライン (--body) またはファイルから渡す (--file)。

引数

名前	Required	目的
<name>	○	エンティティ名 (文字で始まり、文字、数字、アンダースコアのみ)

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-f	--file	パス	—	エンティティ定義を含む JSON ファイルへのパスです (配列fields 必須、 displayName、 description、 isRbacEnabled、 isAnalyticsEnabled 任意)。
—	--body	JSON	—	インラインの JSON エンティティ定義です。 --fileと同じ形状です。
—	--folder-key	キー	—	ターゲット フォルダーのフォルダー キー (GUID) を使用して、テナント レベルのエンティティではなくフォルダー スコープのエンティティを作成します。

エンティティ定義オブジェクト:

{
  "displayName": "Invoice",
  "description": "Invoice records",
  "isRbacEnabled": false,
  "fields": [
    { "name": "title", "type": "STRING" }
  ]
}

重要:

各フィールド オブジェクトには、fieldNameではなく nameが必要です。fieldName渡すと、検証エラー Each field must include a 'name' stringで失敗します。entities getの出力から逐語的にコピーされたフィールド オブジェクト (Name/FieldDataType、PascalCase を使用) もここで受け入れられ、このフラットな書き込み図形に自動的に正規化されます。

有効な type 値は SDK の EntityFieldDataType 列挙型から取得されます。無効な型は失敗し、許可されたすべてのセットがリストされる ValidationError が表示されます。単純なスカラー型 (STRING、 DECIMAL、 GUID、 BOOLEAN、 DATE、 DATETIME、...) 以外にも、いくつかの型が Field オブジェクトに追加の必須プロパティを取ります。

入力	追加の必須プロパティ
CHOICE_SET_SINGLE / CHOICE_SET_MULTIPLE	choiceSetId — df choice-sets listの UUID です。
RELATIONSHIP	referenceEntityId ( entities listから) および referenceFieldId ( entities get <target-id>から) のターゲット エンティティのフィールドの UUID)。任意で、対象のエンティティが別のフォルダーに存在する場合に referenceFolderKey します。
FILE	nameとtypeのみ — サーバーは内部添付ファイルの参照を自動配線します。後でこの値に uip df files uploadを設定します。
MULTILINE_MAX	任意の lengthLimit (UTF-16 バイトの予算、1 から 131072、既定値は約 65,536 文字)。フィルター処理または並べ替え不可。 records list/query サイズ マーカーのみを返します。 records getでコンテンツ全体を読み取ります。テナントの MultilineMax 機能フラグによってゲートされます。

レコードのRELATIONSHIP列には、結合を設定したreferenceFieldIdに関係なく、常にターゲット レコードのId (UUID) が格納されます。値の書き込み方法については、「records insert」をご覧ください。

例

uip df entities create Invoice --file ./invoice.entity.json

uip df entities create Invoice \
    --body '{"displayName":"Invoice","fields":[{"name":"amount","type":"DECIMAL"}]}'

# choice-set, relationship, file, and large-text fields
uip df entities create Expense \
    --body '{"displayName":"Expense","fields":[{"name":"category","type":"CHOICE_SET_SINGLE","choiceSetId":"c1d2e3f4-0000-0000-0000-000000000001","isRequired":true},{"name":"submitter","type":"RELATIONSHIP","referenceEntityId":"a1b2c3d4-0000-0000-0000-000000000010","referenceFieldId":"f1000000-0000-0000-0000-000000000100","isRequired":true},{"name":"receipt","type":"FILE"},{"name":"notes","type":"MULTILINE_MAX"}]}'

データシェイプ(--output json)

{
  "Code": "EntityCreated",
  "Data": { "ID": "a1b2c3d4-0000-0000-0000-000000000001" }
}

uip df entities update

エンティティのメタデータまたはスキーマを更新する。本文は、 addFields、 updateFields、 removeFields、 displayName、 description、 isAnalyticsEnabled/isRbacEnabledを受け入れます。エンティティ name 自体は不変です。更新本文に含めることはできません。

引数

名前	Required	目的
<id>	○	エンティティ ID (UUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-f	--file	パス	—	更新オプションを含む JSON ファイルへのパスです。
—	--body	JSON	—	インライン JSON 更新オプション。
-y	--yes	フラグ	—	removeFieldsが空でない場合は必須です — フィールドの削除は元に戻せないことを確認します。
—	--reason	text	—	removeFieldsが空でない場合は必須です。呼び出し元がログに記録できるように応答でエコーバックされます。
—	--folder-key	キー	—	エンティティを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のエンティティの場合)。

• addFields — 新しいフィールドの配列、フラットな書き込み図形 (name + type、および種類固有の追加機能 — 上記の「create」セクションをご覧ください)。entities get からコピーされたフィールド オブジェクトも受け入れられ、正規化されます。
• updateFields — フィールド id (entities getから) でキーを設定する配列で、メタデータ プロパティが変更されます (例: displayName、description、isRequired、isRbacEnabled、isEncrypted、isHiddenField、defaultValue、制約)。完全にコピーしたフィールド オブジェクトをここに貼り付けないでください。 id に加えて、変更されるフラット プロパティのみを渡します。updateFields フィールドの type や isUnique の設定を変更することはできません。
• removeFields — ID ではなく名前で識別される{"name": "<fieldName>"}オブジェクトの配列です。-y/--yesと--reason "<text>"が必要です。この操作を実行すると、フィールドに保存された値が削除され、元に戻せません。
• エンティティのメタデータ (description、 isRbacEnabled、 isAnalyticsEnabled) を更新するには、displayName も同じ本文に存在する必要があります。 が変更されていない場合は、最初に entities getで現在のdisplayNameを取得してください。

例

# Add a field
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"addFields":[{"name":"note","type":"STRING","lengthLimit":200}]}'

# Rename an existing field's display name
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"updateFields":[{"id":"f1000000-0000-0000-0000-000000000002","displayName":"Amount (USD)","isRequired":true}]}'

# Remove a field — destructive, requires --yes and --reason
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"removeFields":[{"name":"oldColumn"}]}' \
    --yes --reason "quarterly cleanup"

データシェイプ(--output json)

{
  "Code": "EntityUpdated",
  "Data": { "ID": "a1b2c3d4-0000-0000-0000-000000000001" }
}

更新に removeFieldsが含まれる場合は、削除された内容も応答でエコーされます。

{
  "Code": "EntityUpdated",
  "Data": {
    "ID": "a1b2c3d4-0000-0000-0000-000000000001",
    "RemovedFields": ["oldColumn"],
    "Reason": "quarterly cleanup"
  }
}

UIP DF エンティティの削除

エンティティを完全に削除する。これは元に 戻すことができず 、エンティティのスキーマとそのすべてのレコードが削除されます。

引数

名前	Required	目的
<id>	○	エンティティ ID (UUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-y	--yes	フラグ	—	必須。これは元に戻せない操作であることを確認します。
—	--reason	text	—	必須。削除の理由 — 呼び出し元がログに記録できるように応答でエコーバックされます。
—	--folder-key	キー	—	エンティティを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のエンティティの場合)。

例

uip df entities delete a1b2c3d4-0000-0000-0000-000000000001 \
    --yes --reason "test entity cleanup"

データシェイプ(--output json)

{
  "Code": "EntityDeleted",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Reason": "test entity cleanup"
  }
}

関連

• uip df records — これらのエンティティが保持する行を管理します。
• uip df files — レコードの添付ファイル
• uip df choice-sets — CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE フィールドで参照されるチョイス セットです。
• uip vss generate — Data Fabric スキーマのエクスポートから TypeScript 型を生成します。

参照

• Data Fabric ツールの概要
• グローバル オプション
• 終了コード