mirror of
https://github.com/datahub-project/datahub.git
synced 2025-08-31 12:52:13 +00:00
1 line
48 KiB
JavaScript
1 line
48 KiB
JavaScript
"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[3542],{15680:(e,n,t)=>{t.d(n,{xA:()=>m,yg:()=>y});var a=t(96540);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function r(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?i(Object(t),!0).forEach((function(n){o(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):i(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function s(e,n){if(null==e)return{};var t,a,o=function(e,n){if(null==e)return{};var t,a,o={},i=Object.keys(e);for(a=0;a<i.length;a++)t=i[a],n.indexOf(t)>=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)t=i[a],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var l=a.createContext({}),c=function(e){var n=a.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},m=function(e){var n=c(e.components);return a.createElement(l.Provider,{value:n},e.children)},d="mdxType",p={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},u=a.forwardRef((function(e,n){var t=e.components,o=e.mdxType,i=e.originalType,l=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),d=c(t),u=o,y=d["".concat(l,".").concat(u)]||d[u]||p[u]||i;return t?a.createElement(y,r(r({ref:n},m),{},{components:t})):a.createElement(y,r({ref:n},m))}));function y(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var i=t.length,r=new Array(i);r[0]=u;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[d]="string"==typeof e?e:o,r[1]=s;for(var c=2;c<i;c++)r[c]=t[c];return a.createElement.apply(null,r)}return a.createElement.apply(null,t)}u.displayName="MDXCreateElement"},18609:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>l,default:()=>y,frontMatter:()=>s,metadata:()=>c,toc:()=>d});t(96540);var a=t(15680);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){return n=null!=n?n:{},Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):function(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))})),e}function r(e,n){if(null==e)return{};var t,a,o=function(e,n){if(null==e)return{};var t,a,o={},i=Object.keys(e);for(a=0;a<i.length;a++)t=i[a],n.indexOf(t)>=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)t=i[a],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}const s={sidebar_position:12,title:"Domain",slug:"/generated/metamodel/entities/domain",custom_edit_url:"https://github.com/datahub-project/datahub/blob/master/docs/generated/metamodel/entities/domain.md"},l="Domain",c={unversionedId:"docs/generated/metamodel/entities/domain",id:"version-1.1.0/docs/generated/metamodel/entities/domain",title:"Domain",description:"A data domain within an organization.",source:"@site/versioned_docs/version-1.1.0/docs/generated/metamodel/entities/domain.md",sourceDirName:"docs/generated/metamodel/entities",slug:"/generated/metamodel/entities/domain",permalink:"/docs/1.1.0/generated/metamodel/entities/domain",draft:!1,editUrl:"https://github.com/datahub-project/datahub/blob/master/docs/generated/metamodel/entities/domain.md",tags:[],version:"1.1.0",sidebarPosition:12,frontMatter:{sidebar_position:12,title:"Domain",slug:"/generated/metamodel/entities/domain",custom_edit_url:"https://github.com/datahub-project/datahub/blob/master/docs/generated/metamodel/entities/domain.md"},sidebar:"overviewSidebar",previous:{title:"CorpGroup",permalink:"/docs/1.1.0/generated/metamodel/entities/corpgroup"},next:{title:"Container",permalink:"/docs/1.1.0/generated/metamodel/entities/container"}},m={},d=[{value:"Aspects",id:"aspects",level:2},{value:"domainProperties",id:"domainproperties",level:3},{value:"institutionalMemory",id:"institutionalmemory",level:3},{value:"ownership",id:"ownership",level:3},{value:"structuredProperties",id:"structuredproperties",level:3},{value:"forms",id:"forms",level:3},{value:"testResults",id:"testresults",level:3},{value:"displayProperties",id:"displayproperties",level:3},{value:"Relationships",id:"relationships",level:2},{value:"Self",id:"self",level:3},{value:"Outgoing",id:"outgoing",level:3},{value:"Incoming",id:"incoming",level:3},{value:"Global Metadata Model",id:"global-metadata-model",level:2}],p={toc:d},u="wrapper";function y(e){var{components:n}=e,t=r(e,["components"]);return(0,a.yg)(u,i(function(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{},a=Object.keys(t);"function"==typeof Object.getOwnPropertySymbols&&(a=a.concat(Object.getOwnPropertySymbols(t).filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable})))),a.forEach((function(n){o(e,n,t[n])}))}return e}({},p,t),{components:n,mdxType:"MDXLayout"}),(0,a.yg)("h1",{id:"domain"},"Domain"),(0,a.yg)("p",null,"A data domain within an organization."),(0,a.yg)("h2",{id:"aspects"},"Aspects"),(0,a.yg)("h3",{id:"domainproperties"},"domainProperties"),(0,a.yg)("p",null,"Information about a Domain"),(0,a.yg)("details",null,(0,a.yg)("summary",null,"Schema"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-javascript"},'{\n "type": "record",\n "Aspect": {\n "name": "domainProperties"\n },\n "name": "DomainProperties",\n "namespace": "com.linkedin.domain",\n "fields": [\n {\n "Searchable": {\n "/*": {\n "fieldType": "TEXT",\n "queryByDefault": true\n }\n },\n "type": {\n "type": "map",\n "values": "string"\n },\n "name": "customProperties",\n "default": {},\n "doc": "Custom property bag."\n },\n {\n "Searchable": {\n "boostScore": 10.0,\n "enableAutocomplete": true,\n "fieldNameAliases": [\n "_entityName"\n ],\n "fieldType": "WORD_GRAM"\n },\n "type": "string",\n "name": "name",\n "doc": "Display name of the Domain"\n },\n {\n "Searchable": {\n "fieldType": "TEXT",\n "hasValuesFieldName": "hasDescription"\n },\n "type": [\n "null",\n "string"\n ],\n "name": "description",\n "default": null,\n "doc": "Description of the Domain"\n },\n {\n "Searchable": {\n "/time": {\n "fieldName": "createdTime",\n "fieldType": "DATETIME"\n }\n },\n "type": [\n "null",\n {\n "type": "record",\n "name": "AuditStamp",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": "long",\n "name": "time",\n "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": "string",\n "name": "actor",\n "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": [\n "null",\n "string"\n ],\n "name": "impersonator",\n "default": null,\n "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor."\n },\n {\n "type": [\n "null",\n "string"\n ],\n "name": "message",\n "default": null,\n "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."\n }\n ],\n "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."\n }\n ],\n "name": "created",\n "default": null,\n "doc": "Created Audit stamp"\n },\n {\n "Relationship": {\n "entityTypes": [\n "domain"\n ],\n "name": "IsPartOf"\n },\n "Searchable": {\n "fieldName": "parentDomain",\n "fieldType": "URN",\n "hasValuesFieldName": "hasParentDomain"\n },\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": [\n "null",\n "string"\n ],\n "name": "parentDomain",\n "default": null,\n "doc": "Optional: Parent of the domain"\n }\n ],\n "doc": "Information about a Domain"\n}\n'))),(0,a.yg)("h3",{id:"institutionalmemory"},"institutionalMemory"),(0,a.yg)("p",null,"Institutional memory of an entity. This is a way to link to relevant documentation and provide description of the documentation. Institutional or tribal knowledge is very important for users to leverage the entity."),(0,a.yg)("details",null,(0,a.yg)("summary",null,"Schema"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-javascript"},'{\n "type": "record",\n "Aspect": {\n "name": "institutionalMemory"\n },\n "name": "InstitutionalMemory",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": {\n "type": "array",\n "items": {\n "type": "record",\n "name": "InstitutionalMemoryMetadata",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "java": {\n "class": "com.linkedin.common.url.Url",\n "coercerClass": "com.linkedin.common.url.UrlCoercer"\n },\n "type": "string",\n "name": "url",\n "doc": "Link to an engineering design document or a wiki page."\n },\n {\n "type": "string",\n "name": "description",\n "doc": "Description of the link."\n },\n {\n "type": {\n "type": "record",\n "name": "AuditStamp",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": "long",\n "name": "time",\n "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": "string",\n "name": "actor",\n "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": [\n "null",\n "string"\n ],\n "name": "impersonator",\n "default": null,\n "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor."\n },\n {\n "type": [\n "null",\n "string"\n ],\n "name": "message",\n "default": null,\n "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."\n }\n ],\n "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."\n },\n "name": "createStamp",\n "doc": "Audit stamp associated with creation of this record"\n }\n ],\n "doc": "Metadata corresponding to a record of institutional memory."\n }\n },\n "name": "elements",\n "doc": "List of records that represent institutional memory of an entity. Each record consists of a link, description, creator and timestamps associated with that record."\n }\n ],\n "doc": "Institutional memory of an entity. This is a way to link to relevant documentation and provide description of the documentation. Institutional or tribal knowledge is very important for users to leverage the entity."\n}\n'))),(0,a.yg)("h3",{id:"ownership"},"ownership"),(0,a.yg)("p",null,"Ownership information of an entity."),(0,a.yg)("details",null,(0,a.yg)("summary",null,"Schema"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-javascript"},'{\n "type": "record",\n "Aspect": {\n "name": "ownership"\n },\n "name": "Ownership",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": {\n "type": "array",\n "items": {\n "type": "record",\n "name": "Owner",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "Relationship": {\n "entityTypes": [\n "corpuser",\n "corpGroup"\n ],\n "name": "OwnedBy"\n },\n "Searchable": {\n "addToFilters": true,\n "fieldName": "owners",\n "fieldType": "URN",\n "filterNameOverride": "Owned By",\n "hasValuesFieldName": "hasOwners",\n "queryByDefault": false\n },\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": "string",\n "name": "owner",\n "doc": "Owner URN, e.g. urn:li:corpuser:ldap, urn:li:corpGroup:group_name, and urn:li:multiProduct:mp_name\\n(Caveat: only corpuser is currently supported in the frontend.)"\n },\n {\n "deprecated": true,\n "type": {\n "type": "enum",\n "symbolDocs": {\n "BUSINESS_OWNER": "A person or group who is responsible for logical, or business related, aspects of the asset.",\n "CONSUMER": "A person, group, or service that consumes the data\\nDeprecated! Use TECHNICAL_OWNER or BUSINESS_OWNER instead.",\n "CUSTOM": "Set when ownership type is unknown or a when new one is specified as an ownership type entity for which we have no\\nenum value for. This is used for backwards compatibility",\n "DATAOWNER": "A person or group that is owning the data\\nDeprecated! Use TECHNICAL_OWNER instead.",\n "DATA_STEWARD": "A steward, expert, or delegate responsible for the asset.",\n "DELEGATE": "A person or a group that overseas the operation, e.g. a DBA or SRE.\\nDeprecated! Use TECHNICAL_OWNER instead.",\n "DEVELOPER": "A person or group that is in charge of developing the code\\nDeprecated! Use TECHNICAL_OWNER instead.",\n "NONE": "No specific type associated to the owner.",\n "PRODUCER": "A person, group, or service that produces/generates the data\\nDeprecated! Use TECHNICAL_OWNER instead.",\n "STAKEHOLDER": "A person or a group that has direct business interest\\nDeprecated! Use TECHNICAL_OWNER, BUSINESS_OWNER, or STEWARD instead.",\n "TECHNICAL_OWNER": "person or group who is responsible for technical aspects of the asset."\n },\n "deprecatedSymbols": {\n "CONSUMER": true,\n "DATAOWNER": true,\n "DELEGATE": true,\n "DEVELOPER": true,\n "PRODUCER": true,\n "STAKEHOLDER": true\n },\n "name": "OwnershipType",\n "namespace": "com.linkedin.common",\n "symbols": [\n "CUSTOM",\n "TECHNICAL_OWNER",\n "BUSINESS_OWNER",\n "DATA_STEWARD",\n "NONE",\n "DEVELOPER",\n "DATAOWNER",\n "DELEGATE",\n "PRODUCER",\n "CONSUMER",\n "STAKEHOLDER"\n ],\n "doc": "Asset owner types"\n },\n "name": "type",\n "doc": "The type of the ownership"\n },\n {\n "Relationship": {\n "entityTypes": [\n "ownershipType"\n ],\n "name": "ownershipType"\n },\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": [\n "null",\n "string"\n ],\n "name": "typeUrn",\n "default": null,\n "doc": "The type of the ownership\\nUrn of type O"\n },\n {\n "type": [\n "null",\n {\n "type": "record",\n "name": "OwnershipSource",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": {\n "type": "enum",\n "symbolDocs": {\n "AUDIT": "Auditing system or audit logs",\n "DATABASE": "Database, e.g. GRANTS table",\n "FILE_SYSTEM": "File system, e.g. file/directory owner",\n "ISSUE_TRACKING_SYSTEM": "Issue tracking system, e.g. Jira",\n "MANUAL": "Manually provided by a user",\n "OTHER": "Other sources",\n "SERVICE": "Other ownership-like service, e.g. Nuage, ACL service etc",\n "SOURCE_CONTROL": "SCM system, e.g. GIT, SVN"\n },\n "name": "OwnershipSourceType",\n "namespace": "com.linkedin.common",\n "symbols": [\n "AUDIT",\n "DATABASE",\n "FILE_SYSTEM",\n "ISSUE_TRACKING_SYSTEM",\n "MANUAL",\n "SERVICE",\n "SOURCE_CONTROL",\n "OTHER"\n ]\n },\n "name": "type",\n "doc": "The type of the source"\n },\n {\n "type": [\n "null",\n "string"\n ],\n "name": "url",\n "default": null,\n "doc": "A reference URL for the source"\n }\n ],\n "doc": "Source/provider of the ownership information"\n }\n ],\n "name": "source",\n "default": null,\n "doc": "Source information for the ownership"\n }\n ],\n "doc": "Ownership information"\n }\n },\n "name": "owners",\n "doc": "List of owners of the entity."\n },\n {\n "Searchable": {\n "/*": {\n "fieldType": "MAP_ARRAY",\n "queryByDefault": false\n }\n },\n "type": [\n {\n "type": "map",\n "values": {\n "type": "array",\n "items": "string"\n }\n },\n "null"\n ],\n "name": "ownerTypes",\n "default": {},\n "doc": "Ownership type to Owners map, populated via mutation hook."\n },\n {\n "type": {\n "type": "record",\n "name": "AuditStamp",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": "long",\n "name": "time",\n "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": "string",\n "name": "actor",\n "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": [\n "null",\n "string"\n ],\n "name": "impersonator",\n "default": null,\n "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor."\n },\n {\n "type": [\n "null",\n "string"\n ],\n "name": "message",\n "default": null,\n "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."\n }\n ],\n "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."\n },\n "name": "lastModified",\n "default": {\n "actor": "urn:li:corpuser:unknown",\n "impersonator": null,\n "time": 0,\n "message": null\n },\n "doc": "Audit stamp containing who last modified the record and when. A value of 0 in the time field indicates missing data."\n }\n ],\n "doc": "Ownership information of an entity."\n}\n'))),(0,a.yg)("h3",{id:"structuredproperties"},"structuredProperties"),(0,a.yg)("p",null,"Properties about an entity governed by StructuredPropertyDefinition"),(0,a.yg)("details",null,(0,a.yg)("summary",null,"Schema"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-javascript"},'{\n "type": "record",\n "Aspect": {\n "name": "structuredProperties"\n },\n "name": "StructuredProperties",\n "namespace": "com.linkedin.structured",\n "fields": [\n {\n "type": {\n "type": "array",\n "items": {\n "type": "record",\n "name": "StructuredPropertyValueAssignment",\n "namespace": "com.linkedin.structured",\n "fields": [\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": "string",\n "name": "propertyUrn",\n "doc": "The property that is being assigned a value."\n },\n {\n "type": {\n "type": "array",\n "items": [\n "string",\n "double"\n ]\n },\n "name": "values",\n "doc": "The value assigned to the property."\n },\n {\n "type": [\n "null",\n {\n "type": "record",\n "name": "AuditStamp",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": "long",\n "name": "time",\n "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": "string",\n "name": "actor",\n "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": [\n "null",\n "string"\n ],\n "name": "impersonator",\n "default": null,\n "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor."\n },\n {\n "type": [\n "null",\n "string"\n ],\n "name": "message",\n "default": null,\n "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."\n }\n ],\n "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."\n }\n ],\n "name": "created",\n "default": null,\n "doc": "Audit stamp containing who created this relationship edge and when"\n },\n {\n "type": [\n "null",\n "com.linkedin.common.AuditStamp"\n ],\n "name": "lastModified",\n "default": null,\n "doc": "Audit stamp containing who last modified this relationship edge and when"\n }\n ]\n }\n },\n "name": "properties",\n "doc": "Custom property bag."\n }\n ],\n "doc": "Properties about an entity governed by StructuredPropertyDefinition"\n}\n'))),(0,a.yg)("h3",{id:"forms"},"forms"),(0,a.yg)("p",null,"Forms that are assigned to this entity to be filled out"),(0,a.yg)("details",null,(0,a.yg)("summary",null,"Schema"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-javascript"},'{\n "type": "record",\n "Aspect": {\n "name": "forms"\n },\n "name": "Forms",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "Searchable": {\n "/*/completedPrompts/*/id": {\n "fieldName": "incompleteFormsCompletedPromptIds",\n "fieldType": "KEYWORD",\n "queryByDefault": false\n },\n "/*/completedPrompts/*/lastModified/time": {\n "fieldName": "incompleteFormsCompletedPromptResponseTimes",\n "fieldType": "DATETIME",\n "queryByDefault": false\n },\n "/*/incompletePrompts/*/id": {\n "fieldName": "incompleteFormsIncompletePromptIds",\n "fieldType": "KEYWORD",\n "queryByDefault": false\n },\n "/*/urn": {\n "fieldName": "incompleteForms",\n "fieldType": "URN",\n "queryByDefault": false\n }\n },\n "type": {\n "type": "array",\n "items": {\n "type": "record",\n "name": "FormAssociation",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": "string",\n "name": "urn",\n "doc": "Urn of the applied form"\n },\n {\n "type": {\n "type": "array",\n "items": {\n "type": "record",\n "name": "FormPromptAssociation",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": "string",\n "name": "id",\n "doc": "The id for the prompt. This must be GLOBALLY UNIQUE."\n },\n {\n "type": {\n "type": "record",\n "name": "AuditStamp",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": "long",\n "name": "time",\n "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": "string",\n "name": "actor",\n "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": [\n "null",\n "string"\n ],\n "name": "impersonator",\n "default": null,\n "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor."\n },\n {\n "type": [\n "null",\n "string"\n ],\n "name": "message",\n "default": null,\n "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."\n }\n ],\n "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."\n },\n "name": "lastModified",\n "doc": "The last time this prompt was touched for the entity (set, unset)"\n },\n {\n "type": [\n "null",\n {\n "type": "record",\n "name": "FormPromptFieldAssociations",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": [\n "null",\n {\n "type": "array",\n "items": {\n "type": "record",\n "name": "FieldFormPromptAssociation",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": "string",\n "name": "fieldPath",\n "doc": "The field path on a schema field."\n },\n {\n "type": "com.linkedin.common.AuditStamp",\n "name": "lastModified",\n "doc": "The last time this prompt was touched for the field on the entity (set, unset)"\n }\n ],\n "doc": "Information about the status of a particular prompt for a specific schema field\\non an entity."\n }\n }\n ],\n "name": "completedFieldPrompts",\n "default": null,\n "doc": "A list of field-level prompt associations that are not yet complete for this form."\n },\n {\n "type": [\n "null",\n {\n "type": "array",\n "items": "com.linkedin.common.FieldFormPromptAssociation"\n }\n ],\n "name": "incompleteFieldPrompts",\n "default": null,\n "doc": "A list of field-level prompt associations that are complete for this form."\n }\n ],\n "doc": "Information about the field-level prompt associations on a top-level prompt association."\n }\n ],\n "name": "fieldAssociations",\n "default": null,\n "doc": "Optional information about the field-level prompt associations."\n }\n ],\n "doc": "Information about the status of a particular prompt.\\nNote that this is where we can add additional information about individual responses:\\nactor, timestamp, and the response itself."\n }\n },\n "name": "incompletePrompts",\n "default": [],\n "doc": "A list of prompts that are not yet complete for this form."\n },\n {\n "type": {\n "type": "array",\n "items": "com.linkedin.common.FormPromptAssociation"\n },\n "name": "completedPrompts",\n "default": [],\n "doc": "A list of prompts that have been completed for this form."\n }\n ],\n "doc": "Properties of an applied form."\n }\n },\n "name": "incompleteForms",\n "doc": "All incomplete forms assigned to the entity."\n },\n {\n "Searchable": {\n "/*/completedPrompts/*/id": {\n "fieldName": "completedFormsCompletedPromptIds",\n "fieldType": "KEYWORD",\n "queryByDefault": false\n },\n "/*/completedPrompts/*/lastModified/time": {\n "fieldName": "completedFormsCompletedPromptResponseTimes",\n "fieldType": "DATETIME",\n "queryByDefault": false\n },\n "/*/incompletePrompts/*/id": {\n "fieldName": "completedFormsIncompletePromptIds",\n "fieldType": "KEYWORD",\n "queryByDefault": false\n },\n "/*/urn": {\n "fieldName": "completedForms",\n "fieldType": "URN",\n "queryByDefault": false\n }\n },\n "type": {\n "type": "array",\n "items": "com.linkedin.common.FormAssociation"\n },\n "name": "completedForms",\n "doc": "All complete forms assigned to the entity."\n },\n {\n "Searchable": {\n "/*/form": {\n "fieldName": "verifiedForms",\n "fieldType": "URN",\n "queryByDefault": false\n }\n },\n "type": {\n "type": "array",\n "items": {\n "type": "record",\n "name": "FormVerificationAssociation",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": "string",\n "name": "form",\n "doc": "The urn of the form that granted this verification."\n },\n {\n "type": [\n "null",\n "com.linkedin.common.AuditStamp"\n ],\n "name": "lastModified",\n "default": null,\n "doc": "An audit stamp capturing who and when verification was applied for this form."\n }\n ],\n "doc": "An association between a verification and an entity that has been granted\\nvia completion of one or more forms of type \'VERIFICATION\'."\n }\n },\n "name": "verifications",\n "default": [],\n "doc": "Verifications that have been applied to the entity via completed forms."\n }\n ],\n "doc": "Forms that are assigned to this entity to be filled out"\n}\n'))),(0,a.yg)("h3",{id:"testresults"},"testResults"),(0,a.yg)("p",null,"Information about a Test Result"),(0,a.yg)("details",null,(0,a.yg)("summary",null,"Schema"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-javascript"},'{\n "type": "record",\n "Aspect": {\n "name": "testResults"\n },\n "name": "TestResults",\n "namespace": "com.linkedin.test",\n "fields": [\n {\n "Relationship": {\n "/*/test": {\n "entityTypes": [\n "test"\n ],\n "name": "IsFailing"\n }\n },\n "Searchable": {\n "/*/test": {\n "fieldName": "failingTests",\n "fieldType": "URN",\n "hasValuesFieldName": "hasFailingTests",\n "queryByDefault": false\n }\n },\n "type": {\n "type": "array",\n "items": {\n "type": "record",\n "name": "TestResult",\n "namespace": "com.linkedin.test",\n "fields": [\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": "string",\n "name": "test",\n "doc": "The urn of the test"\n },\n {\n "type": {\n "type": "enum",\n "symbolDocs": {\n "FAILURE": " The Test Failed",\n "SUCCESS": " The Test Succeeded"\n },\n "name": "TestResultType",\n "namespace": "com.linkedin.test",\n "symbols": [\n "SUCCESS",\n "FAILURE"\n ]\n },\n "name": "type",\n "doc": "The type of the result"\n },\n {\n "type": [\n "null",\n "string"\n ],\n "name": "testDefinitionMd5",\n "default": null,\n "doc": "The md5 of the test definition that was used to compute this result.\\nSee TestInfo.testDefinition.md5 for more information."\n },\n {\n "type": [\n "null",\n {\n "type": "record",\n "name": "AuditStamp",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": "long",\n "name": "time",\n "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": "string",\n "name": "actor",\n "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change."\n },\n {\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": [\n "null",\n "string"\n ],\n "name": "impersonator",\n "default": null,\n "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor."\n },\n {\n "type": [\n "null",\n "string"\n ],\n "name": "message",\n "default": null,\n "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."\n }\n ],\n "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."\n }\n ],\n "name": "lastComputed",\n "default": null,\n "doc": "The audit stamp of when the result was computed, including the actor who computed it."\n }\n ],\n "doc": "Information about a Test Result"\n }\n },\n "name": "failing",\n "doc": "Results that are failing"\n },\n {\n "Relationship": {\n "/*/test": {\n "entityTypes": [\n "test"\n ],\n "name": "IsPassing"\n }\n },\n "Searchable": {\n "/*/test": {\n "fieldName": "passingTests",\n "fieldType": "URN",\n "hasValuesFieldName": "hasPassingTests",\n "queryByDefault": false\n }\n },\n "type": {\n "type": "array",\n "items": "com.linkedin.test.TestResult"\n },\n "name": "passing",\n "doc": "Results that are passing"\n }\n ],\n "doc": "Information about a Test Result"\n}\n'))),(0,a.yg)("h3",{id:"displayproperties"},"displayProperties"),(0,a.yg)("p",null,"Properties related to how the entity is displayed in the Datahub UI"),(0,a.yg)("details",null,(0,a.yg)("summary",null,"Schema"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-javascript"},'{\n "type": "record",\n "Aspect": {\n "name": "displayProperties"\n },\n "name": "DisplayProperties",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": [\n "null",\n "string"\n ],\n "name": "colorHex",\n "default": null,\n "doc": "The color associated with the entity in Hex. For example #FFFFFF."\n },\n {\n "type": [\n "null",\n {\n "type": "record",\n "name": "IconProperties",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": {\n "type": "enum",\n "symbolDocs": {\n "MATERIAL": "Material UI"\n },\n "name": "IconLibrary",\n "namespace": "com.linkedin.common",\n "symbols": [\n "MATERIAL"\n ],\n "doc": "Enum of possible icon sources"\n },\n "name": "iconLibrary",\n "doc": "The source of the icon: e.g. Antd, Material, etc"\n },\n {\n "type": "string",\n "name": "name",\n "doc": "The name of the icon"\n },\n {\n "type": "string",\n "name": "style",\n "doc": "Any modifier for the icon, this will be library-specific, e.g. filled/outlined, etc"\n }\n ],\n "doc": "Properties describing an icon associated with an entity"\n }\n ],\n "name": "icon",\n "default": null,\n "doc": "The icon associated with the entity"\n }\n ],\n "doc": "Properties related to how the entity is displayed in the Datahub UI"\n}\n'))),(0,a.yg)("h2",{id:"relationships"},"Relationships"),(0,a.yg)("h3",{id:"self"},"Self"),(0,a.yg)("p",null,"These are the relationships to itself, stored in this entity's aspects"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},"IsPartOf (via ",(0,a.yg)("inlineCode",{parentName:"li"},"domainProperties.parentDomain"),")")),(0,a.yg)("h3",{id:"outgoing"},"Outgoing"),(0,a.yg)("p",null,"These are the relationships stored in this entity's aspects"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("p",{parentName:"li"},"OwnedBy"),(0,a.yg)("ul",{parentName:"li"},(0,a.yg)("li",{parentName:"ul"},"Corpuser via ",(0,a.yg)("inlineCode",{parentName:"li"},"ownership.owners.owner")),(0,a.yg)("li",{parentName:"ul"},"CorpGroup via ",(0,a.yg)("inlineCode",{parentName:"li"},"ownership.owners.owner")))),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("p",{parentName:"li"},"ownershipType"),(0,a.yg)("ul",{parentName:"li"},(0,a.yg)("li",{parentName:"ul"},"OwnershipType via ",(0,a.yg)("inlineCode",{parentName:"li"},"ownership.owners.typeUrn")))),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("p",{parentName:"li"},"IsFailing"),(0,a.yg)("ul",{parentName:"li"},(0,a.yg)("li",{parentName:"ul"},"Test via ",(0,a.yg)("inlineCode",{parentName:"li"},"testResults.failing")))),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("p",{parentName:"li"},"IsPassing"),(0,a.yg)("ul",{parentName:"li"},(0,a.yg)("li",{parentName:"ul"},"Test via ",(0,a.yg)("inlineCode",{parentName:"li"},"testResults.passing"))))),(0,a.yg)("h3",{id:"incoming"},"Incoming"),(0,a.yg)("p",null,"These are the relationships stored in other entity's aspects"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("p",{parentName:"li"},"AssociatedWith"),(0,a.yg)("ul",{parentName:"li"},(0,a.yg)("li",{parentName:"ul"},"Dataset via ",(0,a.yg)("inlineCode",{parentName:"li"},"domains.domains")),(0,a.yg)("li",{parentName:"ul"},"DataJob via ",(0,a.yg)("inlineCode",{parentName:"li"},"domains.domains")),(0,a.yg)("li",{parentName:"ul"},"DataFlow via ",(0,a.yg)("inlineCode",{parentName:"li"},"domains.domains")),(0,a.yg)("li",{parentName:"ul"},"Chart via ",(0,a.yg)("inlineCode",{parentName:"li"},"domains.domains")),(0,a.yg)("li",{parentName:"ul"},"Dashboard via ",(0,a.yg)("inlineCode",{parentName:"li"},"domains.domains")),(0,a.yg)("li",{parentName:"ul"},"Notebook via ",(0,a.yg)("inlineCode",{parentName:"li"},"domains.domains"))))),(0,a.yg)("h2",{id:"global-metadata-model"},(0,a.yg)("a",{parentName:"h2",href:"https://github.com/datahub-project/static-assets/raw/main/imgs/datahub-metadata-model.png"},"Global Metadata Model")),(0,a.yg)("p",null,(0,a.yg)("img",{parentName:"p",src:"https://github.com/datahub-project/static-assets/raw/main/imgs/datahub-metadata-model.png",alt:"Global Graph"})))}y.isMDXComponent=!0}}]); |