98 KiB
table
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json
Schema corresponding to a table that belongs to a database
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | Yes | Unknown status | No | Forbidden | Allowed | none | table.json |
Table entity Type
object (Table entity)
Table entity Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| id | string |
Optional | cannot be null | Basic type |
| name | string |
Required | cannot be null | Table entity |
| description | string |
Optional | cannot be null | Table entity |
| href | string |
Optional | cannot be null | Basic type |
| tableType | string |
Optional | cannot be null | Table entity |
| fullyQualifiedName | string |
Optional | cannot be null | Table entity |
| columns | array |
Required | cannot be null | Table entity |
| tableConstraints | array |
Optional | cannot be null | Table entity |
| usageSummary | object |
Optional | cannot be null | Usage Details type |
| owner | object |
Optional | cannot be null | Entity Reference type |
| followers | array |
Optional | cannot be null | Entity Reference type |
| database | object |
Optional | cannot be null | Table entity |
| tags | array |
Optional | cannot be null | Table entity |
| joins | object |
Optional | cannot be null | Table entity |
| sampleData | object |
Optional | cannot be null | Table entity |
id
Unique id used to identify an entity
id
-
is optional
-
Type:
string -
cannot be null
-
defined in: Basic type
id Type
string
id Constraints
UUID: the string must be a UUID, according to RFC 4122
name
Local name (not fully qualified name) of the table
name
-
is required
-
Type:
string -
cannot be null
-
defined in: Table entity
name Type
string
name Constraints
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
pattern: the string must match the following regular expression:
^[^.]*$
description
Description of the table
description
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
description Type
string
href
Link to this table resource
Link to the resource
href
-
is optional
-
Type:
string -
cannot be null
-
defined in: Basic type
href Type
string
href Constraints
URI: the string must be a URI, according to RFC 3986
tableType
Type for capturing a column in a table
tableType
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
tableType Type
string
tableType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"Regular" |
|
"External" |
|
"View" |
|
"SecureView" |
|
"MaterializedView" |
fullyQualifiedName
Fully qualified name of the table in the form serviceName.databaseName.tableName
fullyQualifiedName
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
fullyQualifiedName Type
string
columns
Columns in the table
columns
-
is required
-
Type:
object[](Details) -
cannot be null
-
defined in: Table entity
columns Type
object[] (Details)
tableConstraints
Table constraints
tableConstraints
-
is optional
-
Type:
object[](Details) -
cannot be null
-
defined in: Table entity
tableConstraints Type
object[] (Details)
usageSummary
Type used to return usage details of an entity
usageSummary
-
is optional
-
Type:
object(Type used to return usage details of an entity) -
cannot be null
-
defined in: Usage Details type
usageSummary Type
object (Type used to return usage details of an entity)
owner
Entity reference that includes entity ID and entity type
owner
-
is optional
-
Type:
object(Entity Reference) -
cannot be null
-
defined in: Entity Reference type
owner Type
object (Entity Reference)
followers
Followers of this table
followers
-
is optional
-
Type:
object[](Entity Reference) -
cannot be null
-
defined in: Entity Reference type
followers Type
object[] (Entity Reference)
database
Entity reference that includes entity ID and entity type
database
-
is optional
-
Type:
object(Entity Reference) -
cannot be null
-
defined in: Table entity
database Type
object (Entity Reference)
tags
Tags for this table
tags
-
is optional
-
Type:
object[](Tag Label) -
cannot be null
-
defined in: Table entity
tags Type
object[] (Tag Label)
joins
Details of other tables this table is frequently joined with
joins
-
is optional
-
Type:
object(Details) -
cannot be null
-
defined in: Table entity
joins Type
object (Details)
sampleData
Information on other tables that this table column is frequently joined with
sampleData
-
is optional
-
Type:
object(Details) -
cannot be null
-
defined in: Table entity
sampleData Type
object (Details)
Table entity Definitions
Definitions group tableType
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableType"}
| Property | Type | Required | Nullable | Defined by |
|---|
Definitions group columnDataType
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/columnDataType"}
| Property | Type | Required | Nullable | Defined by |
|---|
Definitions group columnConstraint
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/columnConstraint"}
| Property | Type | Required | Nullable | Defined by |
|---|
Definitions group tableConstraint
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableConstraint"}
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| constraintType | string |
Optional | cannot be null | Table entity |
| columns | array |
Optional | cannot be null | Table entity |
constraintType
constraintType
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
constraintType Type
string
constraintType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"UNIQUE" |
|
"PRIMARY_KEY" |
|
"FOREIGN_KEY" |
columns
List of column names corresponding to the constraint
columns
-
is optional
-
Type:
string[] -
cannot be null
-
defined in: Table entity
columns Type
string[]
Definitions group columnName
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/columnName"}
| Property | Type | Required | Nullable | Defined by |
|---|
Definitions group tableName
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableName"}
| Property | Type | Required | Nullable | Defined by |
|---|
Definitions group fullyQualifiedColumnName
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/fullyQualifiedColumnName"}
| Property | Type | Required | Nullable | Defined by |
|---|
Definitions group column
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/column"}
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| name | string |
Required | cannot be null | Table entity |
| columnDataType | string |
Required | cannot be null | Table entity |
| description | string |
Optional | cannot be null | Table entity |
| fullyQualifiedName | string |
Optional | cannot be null | Table entity |
| tags | array |
Optional | cannot be null | Table entity |
| columnConstraint | string |
Optional | cannot be null | Table entity |
| ordinalPosition | integer |
Optional | cannot be null | Table entity |
name
Local name (not fully qualified name) of the column
name
-
is required
-
Type:
string -
cannot be null
-
defined in: Table entity
name Type
string
name Constraints
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
pattern: the string must match the following regular expression:
^[^.]*$
columnDataType
Type for capturing a column in a table
columnDataType
-
is required
-
Type:
string -
cannot be null
-
defined in: Table entity
columnDataType Type
string
columnDataType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"NUMBER" |
|
"TINYINT" |
|
"SMALLINT" |
|
"INT" |
|
"BIGINT" |
|
"FLOAT" |
|
"DOUBLE" |
|
"DECIMAL" |
|
"NUMERIC" |
|
"TIMESTAMP" |
|
"TIME" |
|
"DATE" |
|
"DATETIME" |
|
"INTERVAL" |
|
"STRING" |
|
"MEDIUMTEXT" |
|
"TEXT" |
|
"CHAR" |
|
"VARCHAR" |
|
"BOOLEAN" |
|
"BINARY" |
|
"VARBINARY" |
|
"ARRAY" |
|
"BLOB" |
|
"LONGBLOB" |
|
"MEDIUMBLOB" |
|
"MAP" |
|
"STRUCT" |
|
"UNION" |
|
"SET" |
|
"GEOGRAPHY" |
|
"ENUM" |
|
"JSON" |
description
Description of the column
description
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
description Type
string
fullyQualifiedName
Fully qualified name of the column that includes serviceName.databaseName.tableName.columnName
fullyQualifiedName
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
fullyQualifiedName Type
string
fullyQualifiedName Constraints
maximum length: the maximum number of characters for this string is: 256
minimum length: the minimum number of characters for this string is: 1
tags
Tags associated with the column
tags
-
is optional
-
Type:
object[](Tag Label) -
cannot be null
-
defined in: Table entity
tags Type
object[] (Tag Label)
columnConstraint
Column constraint
columnConstraint
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
columnConstraint Type
string
columnConstraint Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"NULL" |
|
"NOT_NULL" |
|
"UNIQUE" |
|
"PRIMARY_KEY" |
columnConstraint Default Value
The default value is:
"NULL"
ordinalPosition
Ordinal position of the column
ordinalPosition
-
is optional
-
Type:
integer -
cannot be null
-
defined in: Table entity
ordinalPosition Type
integer
Definitions group columnJoins
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/columnJoins"}
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| columnName | string |
Optional | cannot be null | Table entity |
| joinedWith | array |
Optional | cannot be null | Table entity |
columnName
Local name (not fully qualified name) of the column
columnName
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
columnName Type
string
columnName Constraints
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
pattern: the string must match the following regular expression:
^[^.]*$
joinedWith
Fully qualified names of the columns that this column is joined with
joinedWith
-
is optional
-
Type:
object[](Details) -
cannot be null
-
defined in: Table entity
joinedWith Type
object[] (Details)
Definitions group tableJoins
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableJoins"}
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| startDate | string |
Optional | cannot be null | Basic type |
| dayCount | integer |
Optional | cannot be null | Table entity |
| columnJoins | array |
Optional | cannot be null | Table entity |
startDate
Date in ISO 8601 format in UTC time. Example - '2018-11-13'
startDate
-
is optional
-
Type:
string -
cannot be null
-
defined in: Basic type
startDate Type
string
startDate Constraints
date: the string must be a date string, according to RFC 3339, section 5.6
dayCount
dayCount
-
is optional
-
Type:
integer -
cannot be null
-
defined in: Table entity
dayCount Type
integer
dayCount Default Value
The default value is:
1
columnJoins
columnJoins
-
is optional
-
Type:
object[](Details) -
cannot be null
-
defined in: Table entity
columnJoins Type
object[] (Details)
Definitions group tableData
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableData"}
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| columns | array |
Optional | cannot be null | Table entity |
| rows | array |
Optional | cannot be null | Table entity |
columns
List of local column names (not fully qualified column names) of the table
columns
-
is optional
-
Type:
string[] -
cannot be null
-
defined in: Table entity
columns Type
string[]
rows
Data for a multiple rows of the table
rows
-
is optional
-
Type:
array[] -
cannot be null
-
defined in: Table entity
rows Type
array[]
table-definitions-column-properties-description
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/column/properties/description
Description of the column
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
description Type
string
table-definitions-column-properties-ordinalposition
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/column/properties/ordinalPosition
Ordinal position of the column
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
ordinalPosition Type
integer
table-definitions-column-properties-tags
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/column/properties/tags
Tags associated with the column
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
tags Type
object[] (Tag Label)
table-definitions-column
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/data/createTable.json#/properties/columns/items
Type for capturing a column in a table
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | createTable.json* |
items Type
object (Details)
items Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| name | string |
Required | cannot be null | Table entity |
| columnDataType | string |
Required | cannot be null | Table entity |
| description | string |
Optional | cannot be null | Table entity |
| fullyQualifiedName | string |
Optional | cannot be null | Table entity |
| tags | array |
Optional | cannot be null | Table entity |
| columnConstraint | string |
Optional | cannot be null | Table entity |
| ordinalPosition | integer |
Optional | cannot be null | Table entity |
name
Local name (not fully qualified name) of the column
name
-
is required
-
Type:
string -
cannot be null
-
defined in: Table entity
name Type
string
name Constraints
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
pattern: the string must match the following regular expression:
^[^.]*$
columnDataType
Type for capturing a column in a table
columnDataType
-
is required
-
Type:
string -
cannot be null
-
defined in: Table entity
columnDataType Type
string
columnDataType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"NUMBER" |
|
"TINYINT" |
|
"SMALLINT" |
|
"INT" |
|
"BIGINT" |
|
"FLOAT" |
|
"DOUBLE" |
|
"DECIMAL" |
|
"NUMERIC" |
|
"TIMESTAMP" |
|
"TIME" |
|
"DATE" |
|
"DATETIME" |
|
"INTERVAL" |
|
"STRING" |
|
"MEDIUMTEXT" |
|
"TEXT" |
|
"CHAR" |
|
"VARCHAR" |
|
"BOOLEAN" |
|
"BINARY" |
|
"VARBINARY" |
|
"ARRAY" |
|
"BLOB" |
|
"LONGBLOB" |
|
"MEDIUMBLOB" |
|
"MAP" |
|
"STRUCT" |
|
"UNION" |
|
"SET" |
|
"GEOGRAPHY" |
|
"ENUM" |
|
"JSON" |
description
Description of the column
description
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
description Type
string
fullyQualifiedName
Fully qualified name of the column that includes serviceName.databaseName.tableName.columnName
fullyQualifiedName
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
fullyQualifiedName Type
string
fullyQualifiedName Constraints
maximum length: the maximum number of characters for this string is: 256
minimum length: the minimum number of characters for this string is: 1
tags
Tags associated with the column
tags
-
is optional
-
Type:
object[](Tag Label) -
cannot be null
-
defined in: Table entity
tags Type
object[] (Tag Label)
columnConstraint
Column constraint
columnConstraint
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
columnConstraint Type
string
columnConstraint Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"NULL" |
|
"NOT_NULL" |
|
"UNIQUE" |
|
"PRIMARY_KEY" |
columnConstraint Default Value
The default value is:
"NULL"
ordinalPosition
Ordinal position of the column
ordinalPosition
-
is optional
-
Type:
integer -
cannot be null
-
defined in: Table entity
ordinalPosition Type
integer
table-definitions-columnconstraint
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/column/properties/columnConstraint
Column constraint
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
columnConstraint Type
string
columnConstraint Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"NULL" |
|
"NOT_NULL" |
|
"UNIQUE" |
|
"PRIMARY_KEY" |
columnConstraint Default Value
The default value is:
"NULL"
table-definitions-columndatatype
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/column/properties/columnDataType
Type for capturing a column in a table
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
columnDataType Type
string
columnDataType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"NUMBER" |
|
"TINYINT" |
|
"SMALLINT" |
|
"INT" |
|
"BIGINT" |
|
"FLOAT" |
|
"DOUBLE" |
|
"DECIMAL" |
|
"NUMERIC" |
|
"TIMESTAMP" |
|
"TIME" |
|
"DATE" |
|
"DATETIME" |
|
"INTERVAL" |
|
"STRING" |
|
"MEDIUMTEXT" |
|
"TEXT" |
|
"CHAR" |
|
"VARCHAR" |
|
"BOOLEAN" |
|
"BINARY" |
|
"VARBINARY" |
|
"ARRAY" |
|
"BLOB" |
|
"LONGBLOB" |
|
"MEDIUMBLOB" |
|
"MAP" |
|
"STRUCT" |
|
"UNION" |
|
"SET" |
|
"GEOGRAPHY" |
|
"ENUM" |
|
"JSON" |
table-definitions-columnjoins-properties-joinedwith-items-properties-joincount
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/columnJoins/properties/joinedWith/items/properties/joinCount
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
joinCount Type
integer
table-definitions-columnjoins-properties-joinedwith-items
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/columnJoins/properties/joinedWith/items
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | table.json* |
items Type
object (Details)
items Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| fullyQualifiedName | string |
Optional | cannot be null | Table entity |
| joinCount | integer |
Optional | cannot be null | Table entity |
fullyQualifiedName
Fully qualified name of the column that includes serviceName.databaseName.tableName.columnName
fullyQualifiedName
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
fullyQualifiedName Type
string
fullyQualifiedName Constraints
maximum length: the maximum number of characters for this string is: 256
minimum length: the minimum number of characters for this string is: 1
joinCount
joinCount
-
is optional
-
Type:
integer -
cannot be null
-
defined in: Table entity
joinCount Type
integer
table-definitions-columnjoins-properties-joinedwith
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/columnJoins/properties/joinedWith
Fully qualified names of the columns that this column is joined with
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
joinedWith Type
object[] (Details)
table-definitions-columnjoins
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableJoins/properties/columnJoins/items
Information on other tables that this table column is frequently joined with
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | table.json* |
items Type
object (Details)
items Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| columnName | string |
Optional | cannot be null | Table entity |
| joinedWith | array |
Optional | cannot be null | Table entity |
columnName
Local name (not fully qualified name) of the column
columnName
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
columnName Type
string
columnName Constraints
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
pattern: the string must match the following regular expression:
^[^.]*$
joinedWith
Fully qualified names of the columns that this column is joined with
joinedWith
-
is optional
-
Type:
object[](Details) -
cannot be null
-
defined in: Table entity
joinedWith Type
object[] (Details)
table-definitions-columnname
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/column/properties/name
Local name (not fully qualified name) of the column
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
name Type
string
name Constraints
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
pattern: the string must match the following regular expression:
^[^.]*$
table-definitions-fullyqualifiedcolumnname
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/column/properties/fullyQualifiedName
Fully qualified name of the column that includes serviceName.databaseName.tableName.columnName
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
fullyQualifiedName Type
string
fullyQualifiedName Constraints
maximum length: the maximum number of characters for this string is: 256
minimum length: the minimum number of characters for this string is: 1
table-definitions-tableconstraint-properties-columns-items
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableConstraint/properties/columns/items
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
items Type
string
table-definitions-tableconstraint-properties-columns
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableConstraint/properties/columns
List of column names corresponding to the constraint
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
columns Type
string[]
table-definitions-tableconstraint-properties-constrainttype
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableConstraint/properties/constraintType
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
constraintType Type
string
constraintType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"UNIQUE" |
|
"PRIMARY_KEY" |
|
"FOREIGN_KEY" |
table-definitions-tableconstraint
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/data/createTable.json#/properties/tableConstraints/items
Table constraint
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | createTable.json* |
items Type
object (Details)
items Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| constraintType | string |
Optional | cannot be null | Table entity |
| columns | array |
Optional | cannot be null | Table entity |
constraintType
constraintType
-
is optional
-
Type:
string -
cannot be null
-
defined in: Table entity
constraintType Type
string
constraintType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"UNIQUE" |
|
"PRIMARY_KEY" |
|
"FOREIGN_KEY" |
columns
List of column names corresponding to the constraint
columns
-
is optional
-
Type:
string[] -
cannot be null
-
defined in: Table entity
columns Type
string[]
table-definitions-tabledata-properties-columns
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableData/properties/columns
List of local column names (not fully qualified column names) of the table
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
columns Type
string[]
table-definitions-tabledata-properties-rows-items
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableData/properties/rows/items
Data for a single row of the table with in the same order as columns fields
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
items Type
array
table-definitions-tabledata-properties-rows
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableData/properties/rows
Data for a multiple rows of the table
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
rows Type
array[]
table-definitions-tabledata
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/properties/sampleData
Information on other tables that this table column is frequently joined with
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | table.json* |
sampleData Type
object (Details)
sampleData Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| columns | array |
Optional | cannot be null | Table entity |
| rows | array |
Optional | cannot be null | Table entity |
columns
List of local column names (not fully qualified column names) of the table
columns
-
is optional
-
Type:
string[] -
cannot be null
-
defined in: Table entity
columns Type
string[]
rows
Data for a multiple rows of the table
rows
-
is optional
-
Type:
array[] -
cannot be null
-
defined in: Table entity
rows Type
array[]
table-definitions-tablejoins-properties-columnjoins
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableJoins/properties/columnJoins
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
columnJoins Type
object[] (Details)
table-definitions-tablejoins-properties-daycount
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableJoins/properties/dayCount
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
dayCount Type
integer
dayCount Default Value
The default value is:
1
table-definitions-tablejoins
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/properties/joins
Details of other tables this table is frequently joined with
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | table.json* |
joins Type
object (Details)
joins Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| startDate | string |
Optional | cannot be null | Basic type |
| dayCount | integer |
Optional | cannot be null | Table entity |
| columnJoins | array |
Optional | cannot be null | Table entity |
startDate
Date in ISO 8601 format in UTC time. Example - '2018-11-13'
startDate
-
is optional
-
Type:
string -
cannot be null
-
defined in: Basic type
startDate Type
string
startDate Constraints
date: the string must be a date string, according to RFC 3339, section 5.6
dayCount
dayCount
-
is optional
-
Type:
integer -
cannot be null
-
defined in: Table entity
dayCount Type
integer
dayCount Default Value
The default value is:
1
columnJoins
columnJoins
-
is optional
-
Type:
object[](Details) -
cannot be null
-
defined in: Table entity
columnJoins Type
object[] (Details)
table-definitions-tablename
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/data/createTable.json#/properties/name
Local name (not fully qualified name) of the table
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | createTable.json* |
name Type
string
name Constraints
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
pattern: the string must match the following regular expression:
^[^.]*$
table-definitions-tabletype-javaenums-0
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableType/javaEnums/0
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
0 Type
unknown
table-definitions-tabletype-javaenums-1
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableType/javaEnums/1
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
1 Type
unknown
table-definitions-tabletype-javaenums-2
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableType/javaEnums/2
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
2 Type
unknown
table-definitions-tabletype-javaenums-3
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableType/javaEnums/3
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
3 Type
unknown
table-definitions-tabletype-javaenums-4
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableType/javaEnums/4
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
4 Type
unknown
table-definitions-tabletype
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/data/createTable.json#/properties/tableType
Type for capturing a column in a table
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | createTable.json* |
tableType Type
string
tableType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"Regular" |
|
"External" |
|
"View" |
|
"SecureView" |
|
"MaterializedView" |
table-definitions
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
definitions Type
unknown
table-properties-columns
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/properties/columns
Columns in the table
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
columns Type
object[] (Details)
table-properties-description
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/properties/description
Description of the table
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
description Type
string
table-properties-fullyqualifiedname
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/properties/fullyQualifiedName
Fully qualified name of the table in the form serviceName.databaseName.tableName
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
fullyQualifiedName Type
string
table-properties-name
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/properties/name
Local name (not fully qualified name) of the table
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
name Type
string
name Constraints
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
pattern: the string must match the following regular expression:
^[^.]*$
table-properties-tableconstraints
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/properties/tableConstraints
Table constraints
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
tableConstraints Type
object[] (Details)
table-properties-tabletype
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/properties/tableType
Type for capturing a column in a table
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
tableType Type
string
tableType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"Regular" |
|
"External" |
|
"View" |
|
"SecureView" |
|
"MaterializedView" |
table-properties-tags
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/properties/tags
Tags for this table
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | table.json* |
tags Type
object[] (Tag Label)