UIP DF エンティティ

uip df entities は、Data Fabric のエンティティ スキーマを参照して変更します。エンティティは、型付けされたデータ モデルであり、名前付きのフィールドと型を持つ行図形です。動詞は、発見(list、get)とオーサリング(create、update)をカバーしています。レコードレベルの操作は uip df recordsで行われます。フィールドの削除は、意図的に updateでサポートされていません。

概要

uip df entities <verb> [options]

動詞

動詞	目的
list	テナント内のすべてのエンティティのリストを取得します。必要に応じて、フェデレーション アカウントを除外します。
get	1 つのエンティティのスキーマ (すべてのフィールドを含む) を返します。
create	JSON 定義から新しいエンティティを作成します。
update	エンティティのメタデータまたはスキーマを更新します (フィールドを追加または更新します。 removeFields は拒否されます)。

uip df エンティティ リスト

テナント内のすべてのエンティティのリストを取得します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--native-only	フラグ	無効	ネイティブ エンティティのみを表示します。外部コネクタ接続によってサポートされるフェデレーション エンティティを除外します。

例

uip df entities list

uip df entities list --native-only

uip df entities list \
    --output-filter 'Data[].{name:Name, id:ID, fields:FieldCount}'

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

{
  "Code": "EntityList",
  "Data": [
    {
      "Name": "Invoice",
      "DisplayName": "Invoice",
      "ID": "a1b2c3d4-0000-0000-0000-000000000001",
      "Type": "Standard",
      "Source": "Native",
      "Description": "Invoice records",
      "FieldCount": 8
    }
  ]
}

フェデレーション エンティティは、 Source を Federated または Federated (<connector>)として報告します。

uip df エンティティ get

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

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

# Just the field list
uip df entities get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Fields[].{name:Name, type:Type}'

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

{
  "Code": "EntitySchema",
  "Data": {
    "Name": "Invoice",
    "DisplayName": "Invoice",
    "ID": "a1b2c3d4-0000-0000-0000-000000000001",
    "Type": "Standard",
    "Description": "Invoice records",
    "Fields": [
      {
        "ID": "f1000000-0000-0000-0000-000000000001",
        "Name": "id",
        "DisplayName": "ID",
        "Type": "Guid",
        "Required": true,
        "PrimaryKey": true,
        "System": true
      }
    ]
  }
}

uip df エンティティの作成

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-f	--file	パス	—	エンティティ定義を含む JSON ファイルへのパス (fields 配列が必要)。
—	--body	JSON	—	インライン JSON エンティティ定義。

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

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

各フィールドに文字列として fieldName を含める必要があります。有効な type 値は、SDK の EntityFieldDataType 列挙型から取得されます (例: STRING、 DECIMAL、 GUID、 BOOLEAN、 DATE、 DATETIME)。無効な型は失敗し ValidationError 許可されたセットが一覧表示されます。

例

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

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

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

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

UIP DF エンティティの更新

エンティティのメタデータまたはスキーマを更新します。本体は、 addFields、 updateFields、 displayName、 description、および isRbacEnabledを受け入れます。removeFields 意図的に拒否された — フィールドの削除はサポートされていません。各 addFields エントリには fieldNameが必要です。 updateFields の各エントリには id が必要です (フィールド ID を entities getで検出)。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-f	--file	パス	—	更新オプションを含む JSON ファイルへのパスです。
—	--body	JSON	—	インライン JSON 更新オプション。

例

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

# Rename an existing field
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"updateFields":[{"id":"f1000000-0000-0000-0000-000000000002","displayName":"Total"}]}'

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

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

関連

• uip df records — これらのエンティティが保持する行を管理します。
• uip df files — レコードの添付ファイル
• uip vss generate — Data Fabric スキーマのエクスポートから TypeScript 型を生成します。

参照

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