json.schema.entity.data.dashboardDataModel.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation
There is a newer version: 1.6.0-rc1
{
  "$id": "https://open-metadata.org/schema/entity/data/dashboardDataModel.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DashboardDataModel",
  "$comment": "@om-entity-type",
  "description": "Dashboard Data Model entity definition. Data models are the schemas used to build dashboards, charts, or other data assets.",
  "type": "object",
  "javaType": "org.openmetadata.schema.entity.data.DashboardDataModel",
  "javaInterfaces": ["org.openmetadata.schema.EntityInterface", "org.openmetadata.schema.ColumnsEntityInterface"],
  "definitions": {
    "dataModelType": {
      "javaType": "org.openmetadata.schema.type.DataModelType",
      "description": "This schema defines the type used for describing different types of data models.",
      "type": "string",
      "$comment": "Data Model types supported.",
      "enum": [
        "TableauDataModel",
        "TableauPublishedDatasource",
        "TableauEmbeddedDatasource",
        "SupersetDataModel",
        "MetabaseDataModel",
        "LookMlView",
        "LookMlExplore",
        "PowerBIDataModel",
        "QlikDataModel",
        "QuickSightDataModel",
        "SigmaDataModel"
      ],
      "javaEnums": [
        {
          "name": "TableauDataModel"
        },
        {
          "name": "TableauPublishedDatasource"
        },
        {
          "name": "TableauEmbeddedDatasource"
        },
        {
          "name": "SupersetDataModel"
        },
        {
          "name": "MetabaseDataModel"
        },
        {
          "name": "LookMlView"
        },
        {
          "name": "LookMlExplore"
        },
        {
          "name": "PowerBIDataModel"
        },
        {
          "name": "QlikDataModel"
        },
        {
          "name": "QuickSightDataModel"
        },
        {
          "name": "SigmaDataModel"
        }
      ]
    }
  },
  "properties": {
    "id": {
      "description": "Unique identifier of this data model instance.",
      "$ref": "../../type/basic.json#/definitions/uuid"
    },
    "name": {
      "description": "Name of a data model. Expected to be unique within a Dashboard.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this data model. It could be title or label from the source.",
      "type": "string"
    },
    "fullyQualifiedName": {
      "description": "Fully qualified name of a data model in the form `serviceName.dashboardName.datamodel.datamodelName`.",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "description": {
      "description": "Description of a data model.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "version": {
      "description": "Metadata version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/entityVersion"
    },
    "updatedAt": {
      "description": "Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.",
      "$ref": "../../type/basic.json#/definitions/timestamp"
    },
    "updatedBy": {
      "description": "User who made the update.",
      "type": "string"
    },
    "href": {
      "description": "Link to this data model entity.",
      "$ref": "../../type/basic.json#/definitions/href"
    },
    "owners": {
      "description": "Owners of this data model.",
      "$ref": "../../type/entityReferenceList.json",
      "default": null
    },
    "dataProducts" : {
      "description": "List of data products this entity is part of.",
      "$ref" : "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags for this data model.",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": []
    },
    "changeDescription": {
      "description": "Change that lead to this version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/changeDescription"
    },
    "deleted": {
      "description": "When `true` indicates the entity has been soft deleted.",
      "type": "boolean",
      "default": false
    },
    "followers": {
      "description": "Followers of this dashboard.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "service": {
      "description": "Link to service where this data model is hosted in.",
      "$ref": "../../type/entityReference.json"
    },
    "serviceType": {
      "description": "Service type where this data model is hosted in.",
      "$ref": "../services/dashboardService.json#/definitions/dashboardServiceType"
    },
    "dataModelType": {
      "$ref": "#/definitions/dataModelType"
    },
    "sql": {
      "description": "In case the Data Model is based on a SQL query.",
      "$ref": "../../type/basic.json#/definitions/sqlQuery",
      "default": null
    },
    "columns": {
      "description": "Columns from the data model.",
      "type": "array",
      "items": {
        "$ref": "table.json#/definitions/column"
      },
      "default": null
    },
    "project": {
      "description": "Name of the project / workspace / collection in which the dataModel is contained",
      "type": "string"
    },
    "domain": {
      "description": "Domain the Dashboard Data Model belongs to. When not set, the Dashboard model inherits the domain from the dashboard service it belongs to.",
      "$ref": "../../type/entityReference.json"
    },
    "votes": {
      "description": "Votes on the entity.",
      "$ref": "../../type/votes.json"
    },
    "lifeCycle": {
      "description": "Life Cycle properties of the entity",
      "$ref": "../../type/lifeCycle.json"
    },
    "certification": {
      "$ref": "../../type/assetCertification.json"
    },
    "sourceHash": {
      "description": "Source hash of the entity",
      "type": "string",
      "minLength": 1,
      "maxLength": 32
    },
    "extension": {
      "description": "Entity extension data with custom attributes added to the entity.",
      "$ref": "../../type/basic.json#/definitions/entityExtension"
    }
  },
  "required": [
    "id",
    "name",
    "dataModelType",
    "columns"
  ],
  "additionalProperties": false
}