# Table entity _Schema corresponding to a table that belongs to a database_ Type: `object` path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json $schema: [http://json-schema.org/draft-07/schema#](http://json-schema.org/draft-07/schema#) $id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json **Comment**
_version 0.1.81_ **_Properties_** - id - _Unique identifier that identifies this table instance_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/id - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) - name `required` - _Name of the table. Expected to be unique with in a database_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/name - $ref: [#/definitions/tableName](#/definitions/tableName) - description - _Description of the table_ - Type: `string` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/description - href - _Link to this table resource_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/href - $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref) - tableType - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/tableType - $ref: [#/definitions/tableType](#/definitions/tableType) - fullyQualifiedName - _Fully qualified name of the table in the form serviceName.databaseName.tableName_ - Type: `string` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/fullyQualifiedName - columns `required` - _Columns in the table_ - Type: `array` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/columns - **_Items_** - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/columns/items - $ref: [#/definitions/column](#/definitions/column) - tableConstraints - _Table constraints_ - Type: `array` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/tableConstraints - **_Items_** - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/tableConstraints/items - $ref: [#/definitions/tableConstraint](#/definitions/tableConstraint) - usageSummary - _Latest usage information for this table_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/usageSummary - $ref: [../../type/usageDetails.json](#....typeusagedetails.json) - owner - _Owner of this table_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/owner - $ref: [../../type/entityReference.json](#....typeentityreference.json) - followers - _Followers of this table_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/followers - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist) - database - _Reference to Database that contains this table_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/database - $ref: [../../type/entityReference.json](#....typeentityreference.json) - tags - _Tags for this table_ - Type: `array` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/tags - **_Items_** - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/tags/items - $ref: [../../type/tagLabel.json](#....typetaglabel.json) - joins - _Details of other tables this table is frequently joined with_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/joins - $ref: [#/definitions/tableJoins](#/definitions/tableJoins) - sampleData - _Sample data for the table_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/sampleData - $ref: [#/definitions/tableData](#/definitions/tableData) # definitions **_tableType_** - _Type for capturing a column in a table_ - Type: `string` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableType - The value is restricted to the following: 1. _"Regular"_ 2. _"External"_ 3. _"View"_ 4. _"SecureView"_ 5. _"MaterializedView"_ **_columnDataType_** - _Type for capturing a column in a table_ - Type: `string` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/columnDataType - The value is restricted to the following: 1. _"NUMBER"_ 2. _"TINYINT"_ 3. _"SMALLINT"_ 4. _"INT"_ 5. _"BIGINT"_ 6. _"FLOAT"_ 7. _"DOUBLE"_ 8. _"DECIMAL"_ 9. _"NUMERIC"_ 10. _"TIMESTAMP"_ 11. _"TIME"_ 12. _"DATE"_ 13. _"DATETIME"_ 14. _"INTERVAL"_ 15. _"STRING"_ 16. _"MEDIUMTEXT"_ 17. _"TEXT"_ 18. _"CHAR"_ 19. _"VARCHAR"_ 20. _"BOOLEAN"_ 21. _"BINARY"_ 22. _"VARBINARY"_ 23. _"ARRAY"_ 24. _"BLOB"_ 25. _"LONGBLOB"_ 26. _"MEDIUMBLOB"_ 27. _"MAP"_ 28. _"STRUCT"_ 29. _"UNION"_ 30. _"SET"_ 31. _"GEOGRAPHY"_ 32. _"ENUM"_ 33. _"JSON"_ **_columnConstraint_** - _Column constraint_ - Type: `string` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/columnConstraint - The value is restricted to the following: 1. _"NULL"_ 2. _"NOT_NULL"_ 3. _"UNIQUE"_ 4. _"PRIMARY_KEY"_ - Default: _"NULL"_ **_tableConstraint_** - _Table constraint_ - Type: `object` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableConstraint - **_Properties_** - constraintType - Type: `string` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableConstraint/properties/constraintType - The value is restricted to the following: 1. _"UNIQUE"_ 2. _"PRIMARY_KEY"_ 3. _"FOREIGN_KEY"_ - columns - _List of column names corresponding to the constraint_ - Type: `array` - path: #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_** - Type: `string` - path: #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 **_columnName_** - _Local name (not fully qualified name) of the column_ - Type: `string` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/columnName - The value must match this pattern: `^[^.]*$` - Length: between 1 and 64 **_tableName_** - _Local name (not fully qualified name) of the table_ - Type: `string` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableName - The value must match this pattern: `^[^.]*$` - Length: between 1 and 64 **_fullyQualifiedColumnName_** - _Fully qualified name of the column that includes serviceName.databaseName.tableName.columnName_ - Type: `string` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/fullyQualifiedColumnName - Length: between 1 and 256 **_column_** - _Type for capturing a column in a table_ - Type: `object` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column - **_Properties_** - name `required` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/name - $ref: [#/definitions/columnName](#/definitions/columnName) - columnDataType `required` - _Data type of the column (int, date etc.)_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/columnDataType - $ref: [#/definitions/columnDataType](#/definitions/columnDataType) - description - _Description of the column_ - Type: `string` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/description - fullyQualifiedName - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/fullyQualifiedName - $ref: [#/definitions/fullyQualifiedColumnName](#/definitions/fullyQualifiedColumnName) - tags - _Tags associated with the column_ - Type: `array` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/tags - **_Items_** - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/tags/items - $ref: [../../type/tagLabel.json](#....typetaglabel.json) - columnConstraint - _Column level constraint_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/columnConstraint - $ref: [#/definitions/columnConstraint](#/definitions/columnConstraint) - ordinalPosition - _Ordinal position of the column_ - Type: `integer` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/ordinalPosition **_columnJoins_** - _Information on other tables that this table column is frequently joined with_ - Type: `object` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/columnJoins - This schema does not accept additional properties. - **_Properties_** - columnName - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/columnJoins/properties/columnName - $ref: [#/definitions/columnName](#/definitions/columnName) - joinedWith - _Fully qualified names of the columns that this column is joined with_ - Type: `array` - path: #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_** - Type: `object` - path: #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_** - fullyQualifiedName - path: #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/fullyQualifiedName - $ref: [#/definitions/fullyQualifiedColumnName](#/definitions/fullyQualifiedColumnName) - joinCount - Type: `integer` - path: #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 **_tableJoins_** - Type: `object` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableJoins - This schema does not accept additional properties. - **_Properties_** - startDate - _Date can be only from today going back to last 29 days_ - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableJoins/properties/startDate - $ref: [../../type/basic.json#/definitions/date](#....typebasic.jsondefinitionsdate) - dayCount - Type: `integer` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableJoins/properties/dayCount - Default: `1` - columnJoins - Type: `array` - path: #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_** - path: #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 - $ref: [#/definitions/columnJoins](#/definitions/columnJoins) **_tableData_** - _Information on other tables that this table column is frequently joined with_ - Type: `object` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableData - This schema does not accept additional properties. - **_Properties_** - columns - _List of local column names (not fully qualified column names) of the table_ - Type: `array` - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableData/properties/columns - **_Items_** - path: #https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableData/properties/columns/items - $ref: [#/definitions/columnName](#/definitions/columnName) - rows - _Data for a multiple rows of the table_ - Type: `array` - path: #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_ - Type: `array` - path: #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 _Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 11:07:08 GMT-0700 (Pacific Daylight Time)_