UIP-df-Entitäten

uip df entities durchsucht und verändert Data Fabric-Entitätsschemas. Eine Entität ist ein typisiertes Datenmodell – eine Zeilenform mit benannten Feldern und Typen. Die Verben decken die Erkennung (list, get) und Erstellung (create, update) ab; Vorgänge auf Datensatzebene live auf uip df records. Das Entfernen von Feldern wird absichtlich nicht durch update unterstützt.

Zusammenfassung

uip df entities <verb> [options]

Verben

Verb	Zweck
list	Alle Entitäten im Mandanten auflisten; Verbundene optional ausschließen.
get	Gibt das Schema (einschließlich aller Felder) einer einzelnen Entität zurück.
create	Erstellen Sie eine neue Entität aus einer JSON-Definition.
update	Aktualisieren Sie die Metadaten oder das Schema einer Entität (Felder hinzufügen oder aktualisieren; removeFields wird abgelehnt).

Liste der UIP-DF-Entitäten

Listen Sie alle Entitäten im Mandanten auf.

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--native-only	Markieren	aus	Nur native Entitäten anzeigen; Verbundentitäten ausschließen, die durch eine externe Connectorverbindung unterstützt werden.

Beispiele

uip df entities list

uip df entities list --native-only

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

Datenform (--output json)

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

Verbundentitäten melden Source als Federated oder Federated (<connector>).

Abrufen von UIP-DF-Entitäten

Gibt das Schema einer einzelnen Entität zurück, einschließlich aller Felder.

Argumente

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

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

Beispiele

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

Datenform (--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-Entitäten erstellen

Eine neue Entität erstellen. Der Entitätsname muss mit einem Buchstaben beginnen und darf nur Buchstaben, Ziffern und Unterstriche enthalten. Übergeben Sie die Definition entweder inline (--body) oder aus einer Datei (--file); die beiden schließen sich gegenseitig aus.

Argumente

Name	Erforderlich	Zweck
<name>	ja	Entitätsname (beginnt mit einem Buchstaben; nur Buchstaben, Ziffern, Unterstriche).

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
-f	--file	Pfad	–	Pfad zur JSON-Datei mit der Entitätsdefinition (fields -Array erforderlich).
–	--body	JSON	–	Inline-Definition der JSON-Entität.

Entitätsdefinitionsobjekt:

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

Jedes Feld muss fieldName als Zeichenfolge enthalten. Gültige type -Werte werden aus dem EntityFieldDataType -Enum des SDK entnommen (z. B. STRING, DECIMAL, GUID, BOOLEAN, DATE, DATETIME). Ungültige Typen schlagen damit fehl, dass ValidationError den zulässigen Satz auflistet.

Beispiele

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

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

Datenform (--output json)

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

Aktualisierung der UIP-DF-Entitäten

Aktualisieren Sie die Metadaten oder das Schema einer Entität. Der Text akzeptiert addFields, updateFields, displayName, description und isRbacEnabled. removeFields wird absichtlich abgelehnt – das Entfernen des Felds wird nicht unterstützt. Jeder addFields -Eintrag erfordert fieldName; Jeder updateFields -Eintrag erfordert id (Feld-IDs mit entities get erkennen).

Argumente

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

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
-f	--file	Pfad	–	Pfad zur JSON-Datei mit Aktualisierungsoptionen.
–	--body	JSON	–	Inline-JSON-Aktualisierungsoptionen.

Beispiele

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

Datenform (--output json)

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

Zugehörig

• uip df records – Verwalten Sie die von diesen Entitäten gehaltenen Zeilen.
• uip df files – Dateianhänge zu Datensätzen.
• uip vss generate – Generieren Sie TypeScript-Typen aus einem Data Fabric-Schemaexport.

Siehe auch

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