OpenMetadata
Search…
Change Event
This schema defines the change event type to capture the changes to entities. Entities change due to user activity, such as updating description of a dataset, changing ownership, or adding new tags. Entity also changes due to activities at the metadata sources, such as a new dataset was created, a datasets was deleted, or schema of a dataset is modified. When state of entity changes, an event is produced. These events can be used to build apps and bots that respond to the change from activities.
Type: object
This schema does not accept additional properties.

Properties

  • eventType required
  • entityType required
    • Entity type that changed. Use the schema of this entity to process the entity attribute.
    • Type: string
  • entityId required
  • entityFullyQualifiedName
    • Fully Qualified Name of entity that was modified by the operation.
    • Type: string
  • previousVersion
    • Version of the entity before this change. Note that not all changes result in entity version change. When entity version is not changed, previousVersion is same as currentVersion.
  • currentVersion
    • Current version of the entity after this change. Note that not all changes result in entity version change. When entity version is not changed, previousVersion is same as currentVersion.
  • userName
    • Name of the user whose activity resulted in the change.
    • Type: string
  • timestamp required
  • changeDescription
  • entity
    • For eventType entityCreated, this field captures JSON coded string of the entity using the schema corresponding to entityType.

Type definitions in this schema

eventType

  • Type of event.
  • Type: string
  • The value is restricted to the following:
    1. 1.
      "entityCreated"
    2. 2.
      "entityUpdated"
    3. 3.
      "entitySoftDeleted"
    4. 4.
      "entityDeleted"

eventFilter

  • Type: object
  • This schema does not accept additional properties.
  • Properties
    • eventType required
    • entities
      • Entities for which the events are needed. Example - table, topic, etc. When not set, events for all the entities will be provided.
      • Type: array
        • Items
        • Type: string
This document was updated on: Tuesday, January 25, 2022
Last modified 23h ago