Documentation sur Oracle Cloud Infrastructure

Événements de catalogue de données

Les événements Oracle Cloud Infrastructure sont des fichiers JSON qui sont émis avec certaines opérations de service et qui contiennent des informations sur cette opération.

Vous pouvez définir des règles qui déclenchent une action particulière lorsqu'un événement se produit. Pour plus d'informations, voir Aperçu du service d'événements et Introduction au service d'événements. Pour plus d'informations sur la gestion des règles pour les événements, voir Gestion des règles pour les événements.

Le catalogue de données émet un événement au cours de l'une des opérations suivantes :

  • Une tâche de collecte commence.
  • Une tâche de collecte se termine.
  • Une tâche de collecte échoue.
  • Une entité de données est mise à jour.
  • Une valeur de propriété personnalisée est mise à jour.

Types d'événement pour les tâches de collecte

Lorsque vous exécutez une tâche de collecte, le catalogue de données extrait des métadonnées techniques d'une source de données connectée dans votre référentiel de catalogue de données. Le catalogue de données émet des événements lorsqu'une tâche de collecte commence et se termine. Par exemple, vous pouvez configurer le service d'événements pour Oracle Cloud Infrastructure pour qu'un courriel vous soit envoyé en cas de succès des tâches de collecte.

Nom convivial Description Type d'événement
Collecte - Début

Lorsque le catalogue de données démarre une tâche de collecte, il émet un événement qui contient des informations sur la tâche, telles que le nom de la ressource de données, l'ID compartiment et le statut de collecte IN_PROGRESS.

 com.oraclecloud.datacatalog.harvestjob.begin
Collecte - Fin

Lorsqu'une tâche de collecte est terminée, le catalogue de données émet un événement dont le statut de collecte est SUCCEEDED ou FAILED.

 com.oraclecloud.datacatalog.harvestjob.end
Exemple d'événement de tâche de collecte

Voici un exemple d'événement de fin de collecte terminé avec succès :

{
    "eventType": "com.oraclecloud.datacatalog.harvestjob.end",
    "eventID": "<unique_ID>",
    "cloudEventsVersion": "0.1",
    "eventTypeVersion": "2.0",
    "source": "DataCatalog",
    "eventTime": "2020-12-02T13:31:31.979Z",
    "contentType": "application/json",
    "data": {
      "eventGroupingId": "<JobExecutionKey>",
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>",
      "compartmentName": "<CompartmentName where the user's catalog resides>",
      "resourceId": "ocid1.datacatalog.oc1.<unique_ID>",
      "additionalDetails": {
        "dataAssetKey": "<DataAssetKey>",
        "dataAssetName": "<DataAssetName>",
        "jobDefinitionKey": "<JobDefinitionKey>",
        "jobDefinitionName": "<JobDefinitionName>",
        "connectionKey": "<ConnectionKey>",
        "connectionName": "<ConnectionName>",
        "jobKey": "<JobKey>",
        "jobExecutionKey": "<JobExecutionKey>",
        "harvestStatus": "SUCCEEDED",
        "jobUrl": "<Url to get the execution details of the job>"
        "HarvestedFoldersCount" : 0,
        "HarvestedEntitiesCount" : 0,
        "HarvestedLogicalEntitiesCount" : 0,
        "HarvestedPhysicalEntitiesCount" : 0,
        "HarvestedArchivedFilesCount" : 0,
        "SkippedFilesCount" : 0,
        "HarvestedUnrecognizedFilesCount" : 0,
        "HarvestedFoldersCountStr" : "0",
        "HarvestedEntitiesCountStr" : "0",
        "HarvestedLogicalEntitiesCountStr" : "0",
        "HarvestedPhysicalEntitiesCountStr" : "0",
        "HarvestedArchivedFilesCountStr" : "0",
        "SkippedFilesCountStr" : "0",
        "HarvestedUnrecognizedFilesCountStr" : "0"
      }
    },
    "extensions": {
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>"
    }
  }

Type d'événement pour les entités de données logiques

Une entité de données logique est un groupe de fichiers du service de stockage d'objets qui sont dérivés en créant des modèles de nom de fichier et en les affectant à une ressource de données. Le catalogue de données émet des événements lorsqu'une entité de données logique est mise à jour. Par exemple, lorsque vous créez, mettez à jour ou supprimez une entité de données logique, le catalogue de données émet un événement sous la forme d'un fichier JSON. Vous pouvez configurer le service d'événements pour Oracle Cloud Infrastructure pour que ce fichier JSON vous soit envoyé par courriel ou Slack lorsque des entités de données logiques sont mises à jour dans un compartiment spécifique.

Nom convivial Description Type d'événement
Entités logiques - Modification

Lorsque vous mettez à jour une entité de données logique, le catalogue de données émet un événement concernant les modifications. Le fichier JSON de l'événement comprend des informations sur les entités de données logiques créées, mises à jour et supprimées.

 com.oraclecloud.datacatalog.changedlogicalentities
Exemple d'événement d'entité de données logique

Voici un exemple d'événement de référence pour une mise à jour d'entités de données logiques :

{
    "eventType": "com.oraclecloud.datacatalog.changedlogicalentities",
    "eventID": "<unique_ID>"
,
    "cloudEventsVersion": "0.1",
    "eventTypeVersion": "2.0",
    "source": "DataCatalog",
    "eventTime": "2020-12-02T13:31:31.979Z",
    "contentType": "application/json",
    "data": {
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>",
      "compartmentName": "<CompartmentName where the user's catalog resides>",
      "resourceId": "ocid1.datacatalog.oc1.<unique_ID>"
,
      "additionalDetails": {
        "dataAssetKey": "<DataAssetKey>",
        "dataAssetName": "<DataAssetName>",
        "jobDefinitionKey": "<JobDefinitionKey>",
        "jobDefinitionName": "<JobDefinitionName>",
        "connectionKey": "<ConnectionKey>",
        "connectionName": "<ConnectionName>",
        "jobKey": "<JobKey>",
        "jobExecutionKey": "<JobExecutionKey>",
        "harvestStatus": "<IN_PROGRESS/SUCCEEDED/FAILED>",
        "createdLogicalEntities": ["LE_key1", "LE_key2"],
        "updatedLogicalEntities": ["LE_key3", "LE_key4"],
        "deletedLogicalEntities": ["LE_key5", "LE_key6"]
      }
    },
    "extensions": {
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>"
    }
  }

Type d'événement pour la mise à jour d'une valeur de propriété personnalisée

Les propriétés personnalisées sont utilisées pour saisir le contexte d'affaires des objets de catalogue de données. Le catalogue de données émet un événement, sous forme de fichier JSON, lorsque la valeur de la propriété personnalisée d'un objet de catalogue de données est mise à jour.

Vous pouvez configurer le service d'événements pour Oracle Cloud Infrastructure de sorte qu'il vous envoie ce fichier JSON par courriel ou au moyen de Slack, à chaque fois que la valeur d'une propriété personnalisée est mise à jour dans un compartiment spécifique.

Nom convivial Description Type d'événement

Valeur de propriété personnalisée - Mise à jour

Lorsque vous ajoutez, mettez à jour ou supprimez la valeur de propriété personnalisée d'un objet de catalogue de données, le catalogue de données émet un événement. Le fichier JSON de l'événement comprend des informations sur l'objet mis à jour, la propriété personnalisée et la valeur de la propriété personnalisée.

 com.oraclecloud.datacatalog.object.customproperty.update
Exemple d'événement de mise à jour de valeur de propriété personnalisée

Voici un événement de référence pour la mise à jour d'une valeur de propriété personnalisée :

{
 "eventType" : "com.oraclecloud.datacatalog.object.customproperty.update",
 "eventID" : "<unique_ID>",
 "cloudEventsVersion" : "0.1",
 "eventTypeVersion" : "2.0",
 "source" : "DataCatalog",
 "eventTime" : "2021-06-21T11:12:15Z",
 "contentType" : "application/json",
 "data" : {
   "compartmentId" : "ocid1.compartment.oc1.<unique_ID>",
   "compartmentName" : "<CompartmentName where the user's catalog resides>",
   "resourceName" : "",
   "resourceId" : "ocid1.datacatalog.oc1.<unique_ID>",
   "additionalDetails" : {
     "associatedObjectKey" : "<AssociatedObjectKey>",
     "associatedObjectType" : "<AssociatedObjectType>",
     "customPropertyKey" : "<CustomPropertyKey>",
     "customPropertyDataType" : "<CustomPropertyDataType>",
     "associatedValue" : "<AssociatedValue>"
   }
 },
  "extensions" : {
   "compartmentId" : "ocid1.compartment.oc1.<unique_ID>"
 }
}