uip df records

「uip df records」の構文とオプション - 単一レコード操作やバッチ操作など、Data Fabric エンティティの行を管理します。

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

概要

uip df records list <id> [-l <n>] [-o <n> | --cursor <cursor>] [--folder-key <key>]
uip df records get <id> <key> [--folder-key <key>]
uip df records insert <id> (-f <path> | --body <json>) [--folder-key <key>]
uip df records update <id> (-f <path> | --body <json>) [--folder-key <key>]
uip df records query <id> (-f <path> | --body <json>) [-l <n>] [-o <n> | --cursor <cursor>] [--folder-key <key>]
uip df records import <id> -f <csv-path> [--folder-key <key>]
uip df records delete <id> <key...> -y --reason <text> [--folder-key <key>]

すべての動詞は --folder-key <key> (フォルダー範囲のエンティティに属するレコードの場合はフォルダー GUID) も受け入れます。

動詞

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

uip df records list

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-l	--limit	Number	50	ページあたりの返されるレコードの数。
-o	--offset	Number	—	このレコード索引を含むページから開始します (ページ境界に切り捨て)。--cursorと相互に排他的です。
—	--cursor	カーソル	—	前の回答の nextCursor.valueから取得したページネーションのカーソル値です。--offsetと相互に排他的です。
—	--folder-key	キー	—	エンティティを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のエンティティの場合)。

例

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

# Continue paging — pass the string from the previous response's Data.nextCursor.value
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.items[].Id'

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

{
  "Code": "RecordList",
  "Data": {
    "items": [
      {
        "Id": "b2c3d4e5-0000-0000-0000-000000000001",
        "amount": 1500,
        "notes": "HasValue=true Length=20000"
      },
      { "Id": "b2c3d4e5-0000-0000-0000-000000000002", "amount": 2750, "notes": null }
    ],
    "totalCount": 2,
    "hasNextPage": false
  }
}

重要:

ページネーション エンベロープ キー (items、 totalCount、 hasNextPage、および (別のページnextCursorが存在する場合は 、 、 previousCursor、 currentPage、 totalPages) は、レコード行独自のIdフィールドとは異なり、キャメルケースです。hasNextPage がtrueされている場合、nextCursor オブジェクト全体ではなく、Data.nextCursor.value (文字列) を--cursorとして返します。

list のMULTILINE_MAXフィールドは、サイズ マーカー ("HasValue=true Length=20000" または空の場合は null ) のみを返します。フル テキストは返されません。以下のgetで値全体をお読みください。

uip df records get

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

引数

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

オプション

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

例

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"
  }
}

listとは異なり、ここでのMULTILINE_MAXフィールドは、サイズ マーカーではなく完全な値を返します。

uip df records insert

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-f	--file	パス	—	レコード データ (オブジェクトまたはオブジェクトの配列) を含む JSON ファイルへのパスです。
—	--body	JSON	—	インライン JSON レコード データ (標準 - から読み取るには を使用します)。
—	--folder-key	キー	—	エンティティを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のエンティティの場合)。

特殊な型のフィールド値

• CHOICE_SET_SINGLE — 選択肢値のnumberId (名前の文字列ではなく整数) — df choice-sets list-values <id>で検索します。
• CHOICE_SET_MULTIPLE — numberId整数の配列です。
• RELATIONSHIP — スキーマが結合に使用するreferenceFieldIdに関係なく、常にターゲット レコードのId (UUID) です。referenceFieldId結合を設定するだけで、格納される値ではありません。
• FILE — insert/updateでは設定できません。フィールドはエンティティのスキーマから自動検出され、ペイロードに存在する場合は拒否されます。後で uip df files uploadを設定します。

例

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

# Choice-set and relationship fields
uip df records insert a1b2c3d4-0000-0000-0000-000000000004 \
    --body '{"category":0,"tags":[1,3],"submitter":"e1f2a3b4-0000-0000-0000-000000000001","amount":250}'

# 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 records update

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-f	--file	パス	—	レコード データを含む JSON ファイルへのパス ( Id フィールドを含む必要があります)。
—	--body	JSON	—	インラインの JSON レコード データ ( Id フィールドを含める必要があります。標準 - から読み取るには を使用します)。
—	--folder-key	キー	—	エンティティを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のエンティティの場合)。

例

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 records query

フィルター処理、並べ替え、集計、フィールド選択を使用してレコードにクエリを実行します。カーソルベースのページネーションがサポートされています。本体は JSON オブジェクトで、オプションのキー filterGroup、 sortOptions、 selectedFields、 aggregates、 groupByを使用できます。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-f	--file	パス	—	クエリ オプションを含む JSON ファイルへのパスです。
—	--body	JSON	—	インライン JSON クエリ オプション ( - を使用して stdin から読み取る)。
-l	--limit	Number	50	ページ サイズ
-o	--offset	Number	—	このレコード索引を含むページから開始します。--cursorと相互に排他的です。
—	--cursor	カーソル	—	前の回答の nextCursor.valueから取得したページネーションのカーソル値です。
—	--folder-key	キー	—	エンティティを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のエンティティの場合)。

クエリ本文のキー

• filterGroup — { "logicalOperator": "AND" | "OR" | 0 | 1, "queryFilters": [...], "filterGroups": [...] }です。logicalOperator は、文字列形式 (大文字と小文字を区別しない) または整数形式 (0 = AND、 1 = OR) を受け入れます。 filterGroups は、複合条件に対して同じ形状のグループを入れ子にします。

• queryFiltersエントリは { "fieldName": "<field>", "operator": "<op>", "value": ... } (in/not inの場合は "valueList": [...]) です。fieldName 文字で始まり、文字、数字、アンダースコア、ドットのみを含める必要があります。

  重要:

  サポートされている演算子は、正確には、 =、 !=、 >、 <、 >=、 <=、 contains、 not contains、 startswith、 endswith、 in、 not inです。eq、==、Equals、like、BETWEEN、正規表現演算子はありません。サーバーは、このセット外のものをすべて拒否します。同じqueryFiltersグループ内の >= + <= として BETWEEN を作成します。

• sortOptions — { "fieldName": "<field>", "isDescending": true | false }の配列です。

• selectedFields — 投影するフィールド名の配列です。

• aggregates — 最大 5 個の { "function": "COUNT" | "SUM" | "AVG" | "MIN" | "MAX", "field": "<field>", "alias": "<name>" } オブジェクトの配列です。alias は任意で、指定する場合は、文字 (文字、数字、アンダースコアのみ、≤128 文字) で始める必要があります。

• groupBy — 集計のグループ化に使用する、最大 5 つのフィールド名の配列です。

例

# Filter by status
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"filterGroup":{"logicalOperator":0,"queryFilters":[{"fieldName":"status","operator":"=","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"]}'

# Aggregate — COUNT grouped by a field
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"aggregates":[{"function":"COUNT","field":"Id","alias":"total"}],"groupBy":["status"]}'

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

{
  "Code": "RecordQuery",
  "Data": {
    "items": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000001", "status": "Paid" } ],
    "totalCount": 1,
    "hasNextPage": false
  }
}

集計クエリの行には、完全なレコード フィールドではなく、 groupBy フィールドの値と各集計の alias が格納されます。

{
  "Code": "RecordQuery",
  "Data": {
    "items": [
      { "status": "Paid", "total": 12 },
      { "status": "Pending", "total": 3 }
    ]
  }
}

uip df records import

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-f	--file	パス	必須	インポートする CSV ファイルへのパスです。
—	--folder-key	キー	—	エンティティを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のエンティティの場合)。

例

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

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

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

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

uip df records delete

1 つ以上のレコードを ID で削除します。これは元に 戻せません。

引数

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

オプション

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

例

uip df records delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 \
    --yes --reason "test cleanup"

# 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 \
    --yes --reason "test cleanup"

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

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

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

関連

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

参照

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