enregistrements df uip

Syntaxe et options pour `uip df enregistrements`, qui gère les lignes dans une entité Data Fabric, y compris les opérations à enregistrement unique et par lots.

uip df records gère les lignes détenues par une entité Data Fabric. Les verbes couvrent la lecture (list, get, query), l'écriture (insert, update, import, delete) et l'importation en bloc à partir de CSV. Les verbes à enregistrement unique renvoient l'enregistrement affecté; les verbes de lot renvoient les nombres de réussite/d’échec et quittent non zéro en cas d’échec partiel. list et query prennent en charge la pagination basée sur curseur.

Synthèse

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

Chaque verbe accepte également --folder-key <key> (un GUID de dossier, pour les enregistrements qui appartiennent à une entité à l'échelle du dossier).

Verbes

Verbe	Objectif
list	Répertorie les enregistrements dans une entité, avec une pagination basée sur un curseur.
get	Obtenez un seul enregistrement par ID.
insert	Insérez un enregistrement (objet) ou plusieurs (tableaux).
update	Mettez à jour un enregistrement (objet) ou plusieurs (tableaux); chacun doit inclure Id.
query	Filtrez, triez, agrégez et projetez les enregistrements à l’aide d’un corps de requête JSON.
import	Importez en bloc des enregistrements à partir d’un fichier CSV.
delete	Supprimez un ou plusieurs enregistrements par ID (irréversible, nécessite -y/--reason).

liste d'enregistrements uip df

Répertorier les enregistrements dans une entité. Prend en charge la pagination basée sur des curseurs.

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité. Recherchez-le avec entities list.

Options

Short	Long	Valeur (Value)	Default	Description
-l	--limit	Numérique	50	Nombre d'enregistrements à renvoyer par page.
-o	--offset	Numérique	—	Commencez par la page contenant cet index d’enregistrement (arrondi à une limite de page). Capture mutuellement exclusive avec --cursor
—	--cursor	Curseur	—	Valeur du curseur de pagination de la valeur nextCursor.value d'une réponse précédente. Capture mutuellement exclusive avec --offset.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'entité, pour les entités à l'échelle du dossier.

Exemples

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'

Format des données (--sortie 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
  }
}

Important :

Les clés de l'enveloppe de pagination (items, totalCount, hasNextPage et — lorsqu'une autre page existe — nextCursor, previousCursor, currentPage, totalPages) sont en casse camelCase, contrairement à ce qui existe dans les lignes d'enregistrement Id Champ . Lorsque la valeur hasNextPage est true, renvoyez Data.nextCursor.value (une chaîne) comme --cursor, et non l'objet nextCursor entier.

Un champ MULTILINE_MAX sur list renvoie uniquement un marqueur de taille ("HasValue=true Length=20000" ou null si vide), et non le texte intégral — lisez la valeur complète avec get ci-dessous.

Obtenir les enregistrements uip df

Obtenez un seul enregistrement par ID.

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.
<key>	oui	ID d’enregistrement.

Options

Short	Long	Valeur (Value)	Default	Description
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'entité, pour les entités à l'échelle du dossier.

Exemple

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

Format des données (--sortie json)

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

Contrairement à list, un champ MULTILINE_MAX renvoie ici sa valeur complète, et non un marqueur de taille.

insertion d'enregistrements uip df

Insérez un ou plusieurs enregistrements. L'entrée peut être un objet JSON unique ou un tableau d'objets.

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.

Options

Short	Long	Valeur (Value)	Default	Description
-f	--file	Chemin d'accès	—	Chemin d’accès au fichier JSON avec des données d’enregistrement (objet ou tableau d’objets).
—	--body	JSON	—	Données d’enregistrement JSON en ligne (utilisez - pour lire à partir de stdin).
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'entité, pour les entités à l'échelle du dossier.

Valeurs de champ des types spéciaux:

• CHOICE_SET_SINGLE — le numberId de la valeur du choix (un entier, pas la chaîne de nom) — recherchez-le avec df choice-sets list-values <id>
• CHOICE_SET_MULTIPLE — un tableau de numberId entiers.
• RELATIONSHIP — toujours le Id de l'enregistrement cible (un UUID), quel que soit le referenceFieldId utilisé par le schéma pour la jointure — referenceFieldId configure uniquement la jointure et non la valeur stockée.
• FILE — ne peut pas être défini via insert/update; le champ est automatiquement détecté à partir du schéma de l'entité et rejeté s'il est présent dans la charge utile. Renseignez-le ensuite avec uip df files upload.

Exemples

# 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

Format des données (--sortie json)

L'insertion d'un enregistrement unique renvoie Code: "RecordInserted" avec l'enregistrement créé. L'insertion par lots renvoie Code: "RecordsBatchInserted":

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

Si un enregistrement échoue dans un lot, la commande se termine non-zéro tout en émettant le résultat complet.

mise à jour des enregistrements uip df

Mettez à jour un ou plusieurs enregistrements. Chaque enregistrement doit inclure un champ Id (ou id).

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.

Options

Short	Long	Valeur (Value)	Default	Description
-f	--file	Chemin d'accès	—	Chemin d’accès au fichier JSON avec des données d’enregistrement (doit inclure le champ Id ).
—	--body	JSON	—	Données d’enregistrement JSON en ligne (doit inclure le champ Id; utiliser - pour lire à partir de stdin).
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'entité, pour les entités à l'échelle du dossier.

Exemple

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

Format des données (--sortie json)

Mises à jour à émission unique Code: "RecordUpdated"; les mises à jour par lots génèrent Code: "RecordsBatchUpdated" avec la même forme que RecordsBatchInserted. Les champs Id manquants échouent avec Failure avant toute écriture.

requête d’enregistrements uip df

Interrogez les enregistrements avec filtrage, tri, agrégation et sélection de champ. Prend en charge la pagination basée sur des curseurs. Le corps est un objet JSON avec des clés facultatives filterGroup, sortOptions, selectedFields, aggregates et groupBy.

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.

Options

Short	Long	Valeur (Value)	Default	Description
-f	--file	Chemin d'accès	—	Chemin d’accès au fichier JSON avec les options de requête.
—	--body	JSON	—	Options de requête JSON intégrées (utilisez - pour lire à partir de stdin).
-l	--limit	Numérique	50	Taille de la page.
-o	--offset	Numérique	—	Commencez à partir de la page contenant cet index d’enregistrement. Capture mutuellement exclusive avec --cursor
—	--cursor	Curseur	—	Valeur du curseur de pagination de la valeur nextCursor.value d'une réponse précédente.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'entité, pour les entités à l'échelle du dossier.

Requête clés du corps

• filterGroup — { "logicalOperator": "AND" | "OR" | 0 | 1, "queryFilters": [...], "filterGroups": [...] }. logicalOperator accepte la forme d'une chaîne (insensible à la casse) ou la forme entière (0 = ET, 1 = OU); filterGroups imbrique des groupes de la même forme pour les conditions composées.

• Les entrées queryFilters sont { "fieldName": "<field>", "operator": "<op>", "value": ... } (ou "valueList": [...] pour in/not in). fieldName doit commencer par une lettre et contenir uniquement des lettres, des chiffres, des traits de soulignement et des points.

  Important :

  Les opérateurs pris en charge sont exactement: =, !=, >, <, >=, <=, contains, not contains, startswith, endswith, in, not in. Il n'y a pas d'opérateur eq, ==, Equals, like, BETWEEN, ou regex - le serveur rejette tout ce qui se trouve en dehors de cet ensemble. Composez une variable entre >= + <= dans le même groupe queryFilters.

• sortOptions — tableau de { "fieldName": "<field>", "isDescending": true | false }.

• selectedFields — tableau des noms de champs du projet.

• aggregates — tableau de 5 objets { "function": "COUNT" | "SUM" | "AVG" | "MIN" | "MAX", "field": "<field>", "alias": "<name>" } maximum. alias est facultatif et, lorsqu'il est indiqué, doit commencer par une lettre (lettres, chiffres, traits de soulignement uniquement, ≉128 caractères).

• groupBy — tableau de 5 noms de champs maximum pour regrouper les agrégats.

Exemples

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

Format des données (--sortie json)

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

Les lignes d'une requête agrégée portent les valeurs de champ groupBy plus les alias de chaque agrégation au lieu de champs d'enregistrement complets:

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

importation d'enregistrements uip df

Importez en bloc des enregistrements à partir d’un fichier CSV.

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.

Options

Short	Long	Valeur (Value)	Default	Description
-f	--file	Chemin d'accès	requis	Chemin d’accès au fichier CSV à importer.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'entité, pour les entités à l'échelle du dossier.

Exemple

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

Format des données (--sortie json)

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

Si le serveur enregistre des erreurs au niveau de la ligne, la réponse inclut également ErrorFileLink pointant vers un rapport d’erreur téléchargeable.

suppression d'enregistrements uip df

Supprimez un ou plusieurs enregistrements par ID. Ceci est irréversible.

Arguments

Nom	Requis	Objectif
<id>	oui	Identifiant de l’entité.
<key...>	oui	Un ou plusieurs ID d’enregistrement à supprimer.

Options

Short	Long	Valeur (Value)	Default	Description
-y	--yes	Drapeau	—	Requis. Confirme que cette opération est irréversible.
—	--reason	text	—	Requis. Motif de la suppression — renvoyé dans la réponse afin que l'appelant puisse la consigner.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'entité, pour les entités à l'échelle du dossier.

Exemples

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"

Format des données (--sortie json)

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

Un échec partiel génère toujours la réponse complète, mais définit le code de sortie 1.

Associé

• uip df entities — découvrez d'abord l'ID d'entité; inspecter le schéma avant de créer des requêtes.
• uip df files — gérez les pièces jointes des fichiers dans les enregistrements ici.
• uip df choice-sets — recherchez les valeurs numberId pour les champs CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE .

Voir également

• Présentation de l’outil Data Fabric
• Options globales
• Codes de sortie