enregistrements df uip

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. Les listes et les requêtes prennent en charge la pagination basée sur curseur.

Synthèse

uip df records <verb> [options]

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

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
-t	--tenant	name	session par défaut	Remplacer le locataire.
-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	—	Curseur de pagination d'une réponse précédente.

Exemples

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'

Format des données (--sortie json)

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

Lorsque davantage de pages existent, la réponse comporte également NextCursor, CurrentPage et TotalPages. Transmettez NextCursor en tant que --cursor pour continuer.

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
-t	--tenant	name	session par défaut	Remplacer le locataire.

Exemples

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

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
-t	--tenant	name	session par défaut	Remplacer le locataire.
-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.

Exemples

# 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

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
-t	--tenant	name	session par défaut	Remplacer le locataire.
-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 ).

Exemples

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 les options de filtre, de tri et de 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 (tableau de { fieldName, isDescending }) et selectedFields (tableau de noms).

Arguments

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

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
-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.
-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	—	Curseur de pagination d'une réponse précédente.

Exemples

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

Format des données (--sortie json)

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

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
-t	--tenant	name	session par défaut	Remplacer le locataire.
-f	--file	Chemin d'accès	requis	Chemin d’accès au fichier CSV à importer.

Exemples

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.

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
-t	--tenant	name	session par défaut	Remplacer le locataire.

Exemples

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

Format des données (--sortie json)

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

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.

Voir également

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