mirror of
https://github.com/datahub-project/datahub.git
synced 2025-08-31 04:25:29 +00:00
1 line
16 KiB
JavaScript
1 line
16 KiB
JavaScript
"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[42833],{15680:(e,n,t)=>{t.d(n,{xA:()=>p,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 r(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 i(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?r(Object(t),!0).forEach((function(n){o(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):r(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function l(e,n){if(null==e)return{};var t,a,o=function(e,n){if(null==e)return{};var t,a,o={},r=Object.keys(e);for(a=0;a<r.length;a++)t=r[a],n.indexOf(t)>=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a<r.length;a++)t=r[a],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var s=a.createContext({}),c=function(e){var n=a.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=c(e.components);return a.createElement(s.Provider,{value:n},e.children)},d="mdxType",m={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,r=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=c(t),u=o,y=d["".concat(s,".").concat(u)]||d[u]||m[u]||r;return t?a.createElement(y,i(i({ref:n},p),{},{components:t})):a.createElement(y,i({ref:n},p))}));function y(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var r=t.length,i=new Array(r);i[0]=u;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[d]="string"==typeof e?e:o,i[1]=l;for(var c=2;c<r;c++)i[c]=t[c];return a.createElement.apply(null,i)}return a.createElement.apply(null,t)}u.displayName="MDXCreateElement"},82227:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>s,default:()=>y,frontMatter:()=>l,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 r(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 i(e,n){if(null==e)return{};var t,a,o=function(e,n){if(null==e)return{};var t,a,o={},r=Object.keys(e);for(a=0;a<r.length;a++)t=r[a],n.indexOf(t)>=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a<r.length;a++)t=r[a],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}const l={sidebar_position:29,title:"Post",slug:"/generated/metamodel/entities/post",custom_edit_url:"https://github.com/datahub-project/datahub/blob/master/docs/generated/metamodel/entities/post.md"},s="Post",c={unversionedId:"docs/generated/metamodel/entities/post",id:"version-1.1.0/docs/generated/metamodel/entities/post",title:"Post",description:"Aspects",source:"@site/versioned_docs/version-1.1.0/docs/generated/metamodel/entities/post.md",sourceDirName:"docs/generated/metamodel/entities",slug:"/generated/metamodel/entities/post",permalink:"/docs/1.1.0/generated/metamodel/entities/post",draft:!1,editUrl:"https://github.com/datahub-project/datahub/blob/master/docs/generated/metamodel/entities/post.md",tags:[],version:"1.1.0",sidebarPosition:29,frontMatter:{sidebar_position:29,title:"Post",slug:"/generated/metamodel/entities/post",custom_edit_url:"https://github.com/datahub-project/datahub/blob/master/docs/generated/metamodel/entities/post.md"},sidebar:"overviewSidebar",previous:{title:"DataHubRole",permalink:"/docs/1.1.0/generated/metamodel/entities/datahubrole"},next:{title:"DataHubView",permalink:"/docs/1.1.0/generated/metamodel/entities/datahubview"}},p={},d=[{value:"Aspects",id:"aspects",level:2},{value:"postInfo",id:"postinfo",level:3},{value:"subTypes",id:"subtypes",level:3},{value:"Relationships",id:"relationships",level:2},{value:"Outgoing",id:"outgoing",level:3},{value:"Global Metadata Model",id:"global-metadata-model",level:2}],m={toc:d},u="wrapper";function y(e){var{components:n}=e,t=i(e,["components"]);return(0,a.yg)(u,r(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}({},m,t),{components:n,mdxType:"MDXLayout"}),(0,a.yg)("h1",{id:"post"},"Post"),(0,a.yg)("h2",{id:"aspects"},"Aspects"),(0,a.yg)("h3",{id:"postinfo"},"postInfo"),(0,a.yg)("p",null,"Information about a DataHub Post."),(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": "postInfo"\n },\n "name": "PostInfo",\n "namespace": "com.linkedin.post",\n "fields": [\n {\n "Searchable": {},\n "type": {\n "type": "enum",\n "symbolDocs": {\n "ENTITY_ANNOUNCEMENT": "The Post is an Entity level announcement.",\n "HOME_PAGE_ANNOUNCEMENT": "The Post is an Home Page announcement."\n },\n "name": "PostType",\n "namespace": "com.linkedin.post",\n "symbols": [\n "HOME_PAGE_ANNOUNCEMENT",\n "ENTITY_ANNOUNCEMENT"\n ],\n "doc": "Enum defining types of Posts."\n },\n "name": "type",\n "doc": "Type of the Post."\n },\n {\n "type": {\n "type": "record",\n "name": "PostContent",\n "namespace": "com.linkedin.post",\n "fields": [\n {\n "Searchable": {\n "fieldType": "TEXT_PARTIAL"\n },\n "type": "string",\n "name": "title",\n "doc": "Title of the post."\n },\n {\n "type": {\n "type": "enum",\n "symbolDocs": {\n "LINK": "Link content",\n "TEXT": "Text content"\n },\n "name": "PostContentType",\n "namespace": "com.linkedin.post",\n "symbols": [\n "TEXT",\n "LINK"\n ],\n "doc": "Enum defining the type of content held in a Post."\n },\n "name": "type",\n "doc": "Type of content held in the post."\n },\n {\n "type": [\n "null",\n "string"\n ],\n "name": "description",\n "default": null,\n "doc": "Optional description of the post."\n },\n {\n "java": {\n "class": "com.linkedin.common.url.Url",\n "coercerClass": "com.linkedin.common.url.UrlCoercer"\n },\n "type": [\n "null",\n "string"\n ],\n "name": "link",\n "default": null,\n "doc": "Optional link that the post is associated with."\n },\n {\n "type": [\n "null",\n {\n "type": "record",\n "name": "Media",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "type": {\n "type": "enum",\n "symbolDocs": {\n "IMAGE": "The Media holds an image."\n },\n "name": "MediaType",\n "namespace": "com.linkedin.common",\n "symbols": [\n "IMAGE"\n ],\n "doc": "Enum defining the type of content a Media object holds."\n },\n "name": "type",\n "doc": "Type of content the Media is storing, e.g. image, video, etc."\n },\n {\n "java": {\n "class": "com.linkedin.common.url.Url",\n "coercerClass": "com.linkedin.common.url.UrlCoercer"\n },\n "type": "string",\n "name": "location",\n "doc": "Where the media content is stored."\n }\n ],\n "doc": "Carries information about which roles a user is assigned to."\n }\n ],\n "name": "media",\n "default": null,\n "doc": "Optional media that the post is storing"\n }\n ],\n "doc": "Content stored inside a Post."\n },\n "name": "content",\n "doc": "Content stored in the post."\n },\n {\n "Searchable": {\n "fieldType": "COUNT"\n },\n "type": "long",\n "name": "created",\n "doc": "The time at which the post was initially created"\n },\n {\n "Searchable": {\n "fieldType": "COUNT"\n },\n "type": "long",\n "name": "lastModified",\n "doc": "The time at which the post was last modified"\n },\n {\n "Searchable": {\n "/time": {\n "fieldName": "created",\n "fieldType": "COUNT"\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": "auditStamp",\n "default": null,\n "doc": "The audit stamp at which the request was last updated"\n },\n {\n "Relationship": {\n "entityTypes": [\n "dataset",\n "schemaField",\n "chart",\n "container",\n "dashboard",\n "dataFlow",\n "dataJob",\n "dataProduct",\n "glossaryTerm",\n "glossaryNode",\n "mlModel",\n "mlFeature",\n "notebook",\n "mlFeatureTable",\n "mlPrimaryKey",\n "mlModelGroup",\n "domain",\n "dataProduct"\n ],\n "name": "PostTarget"\n },\n "Searchable": {},\n "java": {\n "class": "com.linkedin.common.urn.Urn"\n },\n "type": [\n "null",\n "string"\n ],\n "name": "target",\n "default": null,\n "doc": "Optional Entity URN that the post is associated with."\n }\n ],\n "doc": "Information about a DataHub Post."\n}\n'))),(0,a.yg)("h3",{id:"subtypes"},"subTypes"),(0,a.yg)("p",null,"Sub Types. Use this aspect to specialize a generic Entity\ne.g. Making a Dataset also be a View or also be a LookerExplore"),(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": "subTypes"\n },\n "name": "SubTypes",\n "namespace": "com.linkedin.common",\n "fields": [\n {\n "Searchable": {\n "/*": {\n "addToFilters": true,\n "fieldType": "KEYWORD",\n "filterNameOverride": "Sub Type",\n "queryByDefault": false\n }\n },\n "type": {\n "type": "array",\n "items": "string"\n },\n "name": "typeNames",\n "doc": "The names of the specific types."\n }\n ],\n "doc": "Sub Types. Use this aspect to specialize a generic Entity\\ne.g. Making a Dataset also be a View or also be a LookerExplore"\n}\n'))),(0,a.yg)("h2",{id:"relationships"},"Relationships"),(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"},"PostTarget"),(0,a.yg)("ul",{parentName:"li"},(0,a.yg)("li",{parentName:"ul"},"Dataset via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"SchemaField via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"Chart via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"Container via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"Dashboard via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"DataFlow via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"DataJob via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"DataProduct via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"GlossaryTerm via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"GlossaryNode via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"MlModel via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"MlFeature via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"Notebook via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"MlFeatureTable via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"MlPrimaryKey via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"MlModelGroup via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target")),(0,a.yg)("li",{parentName:"ul"},"Domain via ",(0,a.yg)("inlineCode",{parentName:"li"},"postInfo.target"))))),(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}}]); |