Skip to main content

dds.entity

Info

Table with entities

Structure

KeyNameInfoAdditional Info
PKurnUniform Resource Name of entityurn:...
loaded_byA URN of loaded processUsually contains DAG name
entity_nameEntity full nameFor DB table this is 'schema.table'
entity_name_shortShort entity nameFor DB table only table name without schema
entity_typeEntity typeExamples: JOB/SCHEMA/TABLE/COLUMN
infoShort info about entity
search_dataText for the search index
json_dataEntity raw attributesJSON type
json_systemJSON with attributes for search and displayJSON type
json_data_uiList of keys from json_data to display on the webJSON type
codesList of code blocksJSON type
gridUses for card viewJSON type
htmlsList of html blocksJSON type
linksList of links to external pagesJSON type
notificationsList of notification blocksJSON type
tablesList of table blocksJSON type
tagsSimple list with text tagsJSON type
filtersFilter for search and displayJSON type
processed_dttmDatetime of ETL record processingTimestamp

Attributes

AttributeValue
Created2021.08.02
OwnerDate Detective Team
LocationPG

Additional info

We didn't put JSON Schema in the main table because of difficulties with the docusaurus build.

codes

JSON Schema

{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": [
{
"type": "object",
"properties": {
"header": {
"description": "Block header",
"minLength": 1,
"type": "string"
},
"language": {
"description": "Code language",
"default": "sql",
"enum": [
"markdown",
"python",
"sql"
],
"type": "string"
},
"opened": {
"default": "1",
"description": "Opened/closed block",
"enum": [
"0",
"1"
],
"type": "string"
},
"data": {
"description": "Code text",
"type": "string"
}
},
"required": [
"header",
"data"
]
}
]
}

Example

[
{
"header": "Code header",
"language": "sql",
"opened": "1",
"data": "select * from table;"
}
]

json_data_ui

JSON Schema

{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"keys": {
"description": "Key names from json_data, that would be displayed on the web",
"type": "array",
"items": [
{
"type": "string"
}
]
},
"opened": {
"default": "1",
"description": "Opened/closed block",
"enum": [
"0",
"1"
],
"type": "string"
}
},
"required": [
"keys"
]
}

Example

{
"keys": [
"key1",
"key2"
],
"opened": "1"
}

json_system

JSON Schema

{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"card_type": {
"description": "Displayed entity",
"type": "string"
},
"type_for_search": {
"description": "Entity type for search",
"type": "string"
},
"system_for_search": {
"description": "System for search",
"type": "string"
}
}
}

Example

[
{
"card_type": "Table",
"type_for_search": "Table",
"system_for_search": "Greenplum",
}
]

htmls

JSON Schema

{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": [
{
"type": "object",
"properties": {
"data": {
"description": "Text with HTML",
"type": "string"
},
"header": {
"description": "Block header",
"minLength": 1,
"type": "string"
},
"opened": {
"default": "1",
"description": "Opened/closed block",
"enum": [
"0",
"1"
],
"type": "string"
}
},
"required": [
"data",
"header"
]
}
]
}

Example

[
{
"data": "Text with <b>HTML</b>",
"header": "Block header",
"opened": "1"
}
]

JSON Schema

{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": [
{
"type": "object",
"properties": {
"link": {
"description": "URL",
"type": "string"
},
"type": {
"type": "string",
"enum": ["external", "wiki"]
}
},
"required": [
"link",
"type"
]
}
]
}

Example

[
{
"link": "https://github.com/tinkoff/data-detective",
"type": "external"
}
]

notifications

JSON Schema

{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Info - green, success - blue, warning - orange, error - red",
"enum": ["success", "warning", "error", "info"]
},
"header": {
"description": "Block header",
"minLength": 1,
"type": "string"
},
"data": {
"type": "string",
"description": "Block text"
}
},
"required": [
"type",
"data"
]
}
]
}

Example

[
{
"type": "info",
"header": "Header for the green panel",
"data": "Green panel"
}
]

tables

JSON Schema

{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"columns": {
"type": "array",
"items": [
{
"type": "string"
}
]
},
"data": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"columnName": {
"type": "string"
}
},
"required": [
"columnNames..."
]
}
]
},
"display_headers": {
"default": "1",
"description": "Display table headers and block name",
"enum": [
"0",
"1"
],
"type": "string"
},
"header": {
"description": "Table header",
"minLength": 1,
"type": "string"
}
},
"required": [
"columns",
"data",
"display_headers",
"header"
]
}

Example

[
{
"data": [
{
"column1": 101,
"column2": "value1"
},
{
"column1": 102,
"column2": "value2"
}
],
"columns": [
"column1",
"column2"
],
"header": "Table header",
"display_headers": "1"
}
]

filters

JSON Schema

{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"FilterCategoryName": {
"description": "Filters for objects category in widescreen tree",
"default": "Label for filter category name",
"type": "string"
}
},
"required": [
"FilterCategoryName"
]
}

Example

 {
"filters": {
"Type": "Object type",
"User": "Object users",
"Support Team": "Team for support object",
"Customer Team": "Customer of object",
"Author": "Author of object"
}
}