UIP-DF-Datensätze

Syntax und Optionen für „uip df Records“, das Zeilen in einer Data Fabric-Entität verwaltet, einschließlich einzelner Datensätze und Batch-Vorgänge.

uip df records verwaltet die von einer Data Fabric-Entität enthaltenen Zeilen. Verben decken das Lesen (list, get, query), das Schreiben (insert, update, import, delete) und den Massenimport aus CSV ab. Verben mit einem einzelnen Datensatz geben den betroffenen Datensatz zurück; Batch-Verben geben Erfolgs-/Fehlschlaganzahlen zurück und beenden bei Teilfehlern ungleich Null. list und query unterstützen die Cursor-basierte Paginierung.

Zusammenfassung

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>]

Jedes Verb akzeptiert auch --folder-key <key> (eine Ordner-GUID für Datensätze, die zu einer Ordner-Scope-Entität gehören).

Verben

Verb	Zweck
list	Listen Sie Datensätze in einer Entität mit Cursor-basierter Paginierung auf.
get	Rufen Sie einen einzelnen Datensatz nach ID ab.
insert	Fügen Sie einen Datensatz (Objekt) oder mehrere (Array) ein.
update	Einen Datensatz (Objekt) oder viele (Array) aktualisieren; jedes muss Id enthalten.
query	Filtern, Sortieren, Aggregieren und Projektieren von Datensätzen mithilfe eines JSON-Abfragetexts.
import	Massenimport von Datensätzen aus einer CSV-Datei.
delete	Einen oder mehrere Datensätze nach ID löschen (destruktiv, erfordert -y/--reason).

UIP-DF-Datensatzliste

Listen Sie Datensätze in einer Entität auf. Unterstützt die Cursor-basierte Paginierung.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Entitäts-ID (UUID). Finden Sie es mit entities list.

Optionen

Short	Long	Wert	Standard	Beschreibung
-l	--limit	Nummer	50	Anzahl der Datensätze, die pro Seite zurückgegeben werden sollen.
-o	--offset	Nummer	–	Beginnen Sie mit der Seite, die diesen Datensatzindex enthält (abgerundet auf eine Seitengrenze). Sich gegenseitig mit --cursor ausschließen.
–	--cursor	Cursor	–	Paginierungscursorwert aus nextCursor.value einer vorherigen Antwort. Sich gegenseitig mit --offset ausschließen.
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der die Entität enthält, für Entitäten mit Ordner-Scope.

Beispiele

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'

Datenform (--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
  }
}

Wichtig:

Id Paginierungsumschlagschlüssel (items, totalCount, hasNextPage) und – wenn eine andere Seite vorhanden ist – nextCursor, previousCursor, currentPage, totalPages) sind BinnenMajuskel Feld. Wenn hasNextPage gleich true ist, übergeben Sie Data.nextCursor.value (eine Zeichenfolge) als --cursor – nicht das gesamte nextCursor -Objekt.

Ein MULTILINE_MAX -Feld in list gibt nur einen Größenmarker ("HasValue=true Length=20000" oder null wenn leer) zurück, nicht den vollständigen Text – lesen Sie den vollständigen Wert mit get unten.

Abrufen von UIP-DF-Datensätzen

Rufen Sie einen einzelnen Datensatz nach ID ab.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Entitäts-ID (UUID).
<key>	ja	Datensatz-ID (UUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der die Entität enthält, für Entitäten mit Ordner-Scope.

Beispiel

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

Datenform (--output json)

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

Im Gegensatz zu list gibt ein MULTILINE_MAX -Feld hier seinen vollständigen Wert zurück, keinen Größenmarker.

Einfügen von UIP-DF-Datensätzen

Fügen Sie einen oder mehrere Datensätze ein. Die Eingabe kann ein einzelnes JSON-Objekt oder ein Array von Objekten sein.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Entitäts-ID (UUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
-f	--file	Pfad	–	Pfad zur JSON-Datei mit Datensatzdaten (Objekt oder Array von Objekten).
–	--body	JSON	–	Inline-JSON-Datensatzdaten (verwenden Sie - zum Lesen aus Standard).
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der die Entität enthält, für Entitäten mit Ordner-Scope.

Feldwerte für spezielle Typen:

• CHOICE_SET_SINGLE – numberId des Auswahlwerts (ein Integer, nicht die Namenszeichenfolge) – suchen Sie mit df choice-sets list-values <id>.
• CHOICE_SET_MULTIPLE – ein Array von numberId -Integern.
• RELATIONSHIP – immer die Id des Zieldatensatzes (eine UUID), unabhängig davon, welche referenceFieldId das Schema für die Verknüpfung verwendet – referenceFieldId konfiguriert nur die Verknüpfung, nicht der gespeicherte Wert.
• FILE – kann nicht durch insert/update festgelegt werden; Das Feld wird automatisch im Schema der Entität erkannt und abgelehnt, wenn es in der Nutzlast vorhanden ist. Füllen Sie es anschließend mit uip df files upload aus.

Beispiele

# 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

Datenform (--output json)

Das Einfügen eines einzelnen Datensatzes gibt Code: "RecordInserted" mit dem erstellten Datensatz zurück. Batch-Einfügung gibt Code: "RecordsBatchInserted" zurück:

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

Wenn ein Datensatz in einem Batch fehlschlägt, wird der Befehl ungleich Null beendet, während weiterhin das vollständige Ergebnis ausgegeben wird.

Aktualisierung der UIP-DF-Datensätze

Aktualisieren Sie einen oder mehrere Datensätze. Jeder Datensatz muss ein Id (oder id) Feld enthalten.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Entitäts-ID (UUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
-f	--file	Pfad	–	Pfad zur JSON-Datei mit Datensatzdaten (muss das Feld Id enthalten).
–	--body	JSON	–	Inline-JSON-Datensatzdaten (muss das Feld Id enthalten; verwenden Sie -, um aus Standardeinstellungen zu lesen).
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der die Entität enthält, für Entitäten mit Ordner-Scope.

Beispiel

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

Datenform (--output json)

Einzelne Aktualisierungen geben Code: "RecordUpdated" aus; Batch-Updates geben Code: "RecordsBatchUpdated" mit der gleichen Form wie RecordsBatchInserted aus. Fehlende Id -Felder schlagen mit Failure vor dem Schreiben fehl.

Abfrage von uip-df-Datensätzen

Abfragen Sie Datensätze mit Filtern, Sortieren, Aggregation und Feldauswahl. Unterstützt die Cursor-basierte Paginierung. Der Textkörper ist ein JSON-Objekt mit den optionalen Schlüsseln filterGroup, sortOptions, selectedFields, aggregates und groupBy.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Entitäts-ID (UUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
-f	--file	Pfad	–	Pfad zur JSON-Datei mit Abfrageoptionen.
–	--body	JSON	–	Inline-JSON-Abfrageoptionen (verwenden Sie -, um aus Standardeinstellungen zu lesen).
-l	--limit	Nummer	50	Seitengröße.
-o	--offset	Nummer	–	Beginnen Sie mit der Seite, die diesen Datensatzindex enthält. Sich gegenseitig mit --cursor ausschließen.
–	--cursor	Cursor	–	Paginierungscursorwert aus nextCursor.value einer vorherigen Antwort.
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der die Entität enthält, für Entitäten mit Ordner-Scope.

Textschlüssel abfragen

• filterGroup – { "logicalOperator": "AND" | "OR" | 0 | 1, "queryFilters": [...], "filterGroups": [...] }. logicalOperator akzeptiert die String-Form (Groß-/Kleinschreibung wird nicht berücksichtigt) oder die Integer-Form (0 = AND, 1 = OR); filterGroups verschachtelt Gruppen der gleichen Form für zusammengesetzte Bedingungen.

• queryFilters Einträge sind { "fieldName": "<field>", "operator": "<op>", "value": ... } (oder "valueList": [...] für in/not in). fieldName muss mit einem Buchstaben beginnen und darf nur Buchstaben, Ziffern, Unterstriche und Punkte enthalten.

  Wichtig:

  Die unterstützten Operatoren sind genau die folgenden: =, !=, >, <, >=, <=, contains, not contains, startswith, endswith, in, not in. Es gibt keinen eq, ==, Equals, like, BETWEEN - oder Regex-Operator – der Server weist alles außerhalb dieses Satzes zurück. Verfassen Sie ein BETween als >= + <= in derselben queryFilters -Gruppe.

• sortOptions – Array von { "fieldName": "<field>", "isDescending": true | false }.

• selectedFields – Array von Feldnamen für das Projekt.

• aggregates – Array von bis zu 5 { "function": "COUNT" | "SUM" | "AVG" | "MIN" | "MAX", "field": "<field>", "alias": "<name>" } -Objekten. alias ist optional und muss, wenn angegeben, mit einem Buchstaben beginnen (Buchstaben, Ziffern, nur Unterstriche, <128 Zeichen).

• groupBy – Array von bis zu 5 Feldnamen, nach denen Aggregate gruppiert werden sollen.

Beispiele

# 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"]}'

Datenform (--output json)

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

Die Zeilen einer aggregierten Abfrage enthalten die groupBy -Feldwerte zuzüglich der alias jedes Aggregats anstelle der vollständigen Datensatzfelder:

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

Importieren von UIP-DF-Datensätzen

Massenimport von Datensätzen aus einer CSV-Datei.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Entitäts-ID (UUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
-f	--file	Pfad	erforderlich	Pfad zur zu importierenden CSV-Datei.
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der die Entität enthält, für Entitäten mit Ordner-Scope.

Beispiel

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

Datenform (--output json)

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

Wenn der Server Fehler auf Zeilenebene aufzeichnet, enthält die Antwort auch ErrorFileLink das auf einen herunterladbaren Fehlerbericht verweist.

UIP-DF-Datensätze löschen

Löschen Sie einen oder mehrere Datensätze nach ID. Dies kann nicht rückgängig gemacht werden.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Entitäts-ID (UUID).
<key...>	ja	Mindestens eine zu löschende Datensatz-ID.

Optionen

Short	Long	Wert	Standard	Beschreibung
-y	--yes	Markieren	–	Erforderlich. Bestätigt, dass dies ein nicht rückgängig zu machender Vorgang ist.
–	--reason	text	–	Erforderlich. Grund für das Löschen – wird in der Antwort zurückgegeben, damit der Aufrufer ihn protokollieren kann.
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der die Entität enthält, für Entitäten mit Ordner-Scope.

Beispiele

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"

Datenform (--output json)

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

Bei einem Teilfehler wird weiterhin die vollständige Antwort ausgegeben, der Austrittscode wird jedoch auf 1 festgelegt.

Zugehörig

• uip df entities – erkennen Sie zuerst die Entitäts-ID; Überprüfen Sie das Schema, bevor Sie Abfragen erstellen.
• uip df files – Verwalten Sie Dateianhänge für die Datensätze hier.
• uip df choice-sets – numberId -Werte für CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE -Felder suchen.

Siehe auch

• Übersicht über das Data Fabric-Tool
• Globale Optionen
• Exitcodes