OpenMetadata/docs/openmetadata-apis/schemas/entities/table.md

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#

$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
• 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
• 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
• 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
• 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
• 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
• 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
• 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
• 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
• 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
• 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
• 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
• 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

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
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
        • 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
  • 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

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
  • 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 Mon Aug 09 2021 11:07:08 GMT-0700 (Pacific Daylight Time)