UIP DF レコード

uip df records は、Data Fabric エンティティが保持する行を管理します。動詞には、読み取り ( [list]、[ get]、[ query])、書き込み (insert、 update、 import、 delete)、および CSV からの一括インポートが含まれます。単一レコード動詞は、影響を受けるレコードを返します。バッチ動詞は成功/失敗回数を返し、部分的な失敗で 0 以外の値を終了します。リストとクエリでは、カーソルベースのページネーションがサポートされています。

概要

uip df records <verb> [options]

動詞

動詞	目的
list	カーソルベースのページネーションでエンティティ内のレコードのリストを取得します。
get	単一のレコードを ID で取得します。
insert	1 つのレコード (オブジェクト) または多数のレコード (配列) を挿入します。
update	1 つのレコード (オブジェクト) または多数のレコード (配列) を更新します。それぞれに Idを含める必要があります。
query	JSON クエリ本体を使用してレコードをフィルター処理、並べ替え、およびプロジェクトします。
import	CSV ファイルからレコードを一括インポートします。
delete	ID で 1 つ以上のレコードを削除します。

UIP DF レコードのリスト

エンティティ内のレコードのリストを取得します。カーソルベースのページネーションがサポートされています。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-l	--limit	Number	50	ページあたりの返されるレコードの数。
-o	--offset	Number	—	このレコード索引を含むページから開始します (ページ境界に切り捨て)。--cursorと相互に排他的です。
—	--cursor	カーソル	—	前の応答のページネーション カーソル

例

uip df records list a1b2c3d4-0000-0000-0000-000000000001 --limit 2

# Continue paging
uip df records list a1b2c3d4-0000-0000-0000-000000000001 \
    --cursor "eyJwYWdlIjoyfQ=="

# Just the IDs
uip df records list a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Records[].Id'

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

{
  "Code": "RecordList",
  "Data": {
    "TotalCount": 2,
    "Records": [
      { "Id": "b2c3d4e5-0000-0000-0000-000000000001", "amount": 1500 }
    ],
    "HasNextPage": false
  }
}

さらにページが存在する場合、応答には NextCursor、 CurrentPageおよび TotalPagesも含まれます。続行するにはNextCursor--cursorとして戻します。

uip df レコード取得

単一のレコードを ID で取得します。

引数

名前	Required	目的
<id>	○	エンティティ ID (UUID)。
<key>	○	レコード ID (UUID)。

オプション

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

例

uip df records get a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001

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

{
  "Code": "RecordDetails",
  "Data": {
    "Id": "b2c3d4e5-0000-0000-0000-000000000001",
    "amount": 1500,
    "status": "Paid"
  }
}

uip df レコード挿入

1 つ以上のレコードを挿入します。入力には、単一の JSON オブジェクトまたはオブジェクトの配列を指定できます。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-f	--file	パス	—	レコード データ (オブジェクトまたはオブジェクトの配列) を含む JSON ファイルへのパスです。
—	--body	JSON	—	インライン JSON レコード データ。

例

# Single record
uip df records insert a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"amount":1500,"status":"New"}'

# Batch from file
uip df records insert a1b2c3d4-0000-0000-0000-000000000001 \
    --file ./invoices.json

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

単一レコードの挿入は、作成されたレコードで Code: "RecordInserted" を返します。バッチ挿入は Code: "RecordsBatchInserted"を返します。

{
  "Code": "RecordsBatchInserted",
  "Data": {
    "SuccessCount": 1,
    "FailureCount": 0,
    "SuccessRecords": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000010" } ],
    "FailureRecords": []
  }
}

バッチ内のレコードが失敗した場合、コマンドは完全な結果を出力しながら、ゼロ以外の状態を終了します。

UIP DFレコードの更新

1 つ以上のレコードを更新します。各レコードには、 Id (または id) フィールドが含まれている必要があります。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-f	--file	パス	—	レコード データを含む JSON ファイルへのパス ( Id フィールドを含む必要があります)。
—	--body	JSON	—	インライン JSON レコード データ ( Id フィールドを含む必要があります)。

例

uip df records update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"Id":"b2c3d4e5-0000-0000-0000-000000000001","status":"Paid"}'

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

単一の更新ではCode: "RecordUpdated"が出力されます。バッチ更新では、RecordsBatchInsertedと同じ形状のCode: "RecordsBatchUpdated"が出力されます。Idフィールドが見つからない場合、書き込みの前にFailureが発生して失敗します。

uip df レコード クエリ

フィルター、並べ替え、およびフィールド選択オプションを使用してレコードをクエリします。カーソルベースのページネーションがサポートされています。本体は、オプションのキー filterGroup、 sortOptions ( { fieldName, isDescending }の配列)、および selectedFields (名前の配列) を持つ JSON オブジェクトです。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-f	--file	パス	—	クエリ オプションを含む JSON ファイルへのパスです。
—	--body	JSON	—	インライン JSON クエリ オプション。
-l	--limit	Number	50	ページ サイズ
-o	--offset	Number	—	このレコード索引を含むページから開始します。--cursorと相互に排他的です。
—	--cursor	カーソル	—	前の応答のページネーション カーソル

例

# Filter by status
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"filterGroup":{"field":"status","operator":"eq","value":"Paid"}}'

# Sort newest first, project two fields
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"sortOptions":[{"fieldName":"createdAt","isDescending":true}],"selectedFields":["Id","amount"]}'

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

{
  "Code": "RecordQuery",
  "Data": {
    "TotalCount": 2,
    "Records": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000001", "amount": 1500 } ],
    "HasNextPage": false
  }
}

uip df レコードのインポート

CSV ファイルからレコードを一括インポートします。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-f	--file	パス	必須	インポートする CSV ファイルへのパスです。

例

uip df records import a1b2c3d4-0000-0000-0000-000000000001 \
    --file ./invoices.csv

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

{
  "Code": "RecordsImported",
  "Data": {
    "InsertedRecords": 42,
    "TotalRecords": 42
  }
}

サーバーが行レベルのエラーを記録する場合、応答には、ダウンロード可能なエラー レポートを指す ErrorFileLink も含まれます。

uip df レコードの削除

ID で 1 つ以上のレコードを削除します。

引数

名前	Required	目的
<id>	○	エンティティ ID (UUID)。
<key...>	○	削除する 1 つ以上のレコード ID。

オプション

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

例

uip df records delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001

# Bulk delete
uip df records delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000002 \
    b2c3d4e5-0000-0000-0000-000000000003

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

{
  "Code": "RecordsDeleted",
  "Data": {
    "SuccessCount": 1,
    "FailureCount": 0,
    "SuccessRecords": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000001" } ],
    "FailureRecords": []
  }
}

部分的な失敗でも完全な応答は出力されますが、終了コードは 1に設定されます。

関連

• uip df entities — 最初にエンティティIDを発見します。クエリを作成する前にスキーマを検査します。
• uip df files — レコードの添付ファイルをここで管理します。

参照

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