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

Table

This schema defines the Table entity. A Table organizes data in rows and columns and is defined by a Schema. OpenMetadata does not have a separate abstraction for Schema. Both Table and Schema are captured in this entity.

$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json

Type: object

Properties

• id required
  • Unique identifier of this table instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Name of a table. Expected to be unique within a database.
  • $ref: #/definitions/tableName
• description
  • Description of a table.
  • Type: string
• href
  • Link to this table resource.
  • $ref: ../../type/basic.json#/definitions/href
• tableType
  • $ref: #/definitions/tableType
• fullyQualifiedName
  • Fully qualified name of a table in the form serviceName.databaseName.tableName.
  • Type: string
• columns required
  • Columns in this table.
  • Type: array
    • Items
    • $ref: #/definitions/column
• tableConstraints
  • Table constraints.
  • Type: array
    • Items
    • $ref: #/definitions/tableConstraint
• usageSummary
  • Latest usage information for this table.
  • $ref: ../../type/usageDetails.json
• owner
  • Owner of this table.
  • $ref: ../../type/entityReference.json
• followers
  • Followers of this table.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• database
  • Reference to Database that contains this table.
  • $ref: ../../type/entityReference.json
• tags
  • Tags for this table.
  • Type: array
    • Items
    • $ref: ../../type/tagLabel.json
• joins
  • Details of other tables this table is frequently joined with.
  • $ref: #/definitions/tableJoins
• sampleData
  • Sample data for a table.
  • $ref: #/definitions/tableData

Types definitions in this schema

tableType

• This schema defines the type used for describing different types of tables.
• Type: string
• The value is restricted to the following:
  1. "Regular"
  2. "External"
  3. "View"
  4. "SecureView"
  5. "MaterializedView"

columnDataType

• This enum defines the type of data stored in a column.
• Type: string
• 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

• This enum defines the type for column constraint.
• Type: string
• The value is restricted to the following:
  1. "NULL"
  2. "NOT_NULL"
  3. "UNIQUE"
  4. "PRIMARY_KEY"
• Default: "NULL"

tableConstraint

• This enum defines the type for table constraint.
• Type: object
• Properties
  • constraintType
    • Type: string
    • 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
      • Items
      • Type: string

columnName

• Local name not fully qualified name of the column.
• Type: string
• The value must match this pattern: ^[^.]*$
• Length: between 1 and 64

tableName

• Local name not fully qualified name of a table.
• Type: string
• 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
• Length: between 1 and 256

column

• This schema defines the type for a column in a table.
• Type: object
• Properties
  • name required
    • $ref: #/definitions/columnName
  • columnDataType required
    • Data type of the column int, date etc..
    • $ref: #/definitions/columnDataType
  • description
    • Description of the column.
    • Type: string
  • fullyQualifiedName
    • $ref: #/definitions/fullyQualifiedColumnName
  • tags
    • Tags associated with the column.
    • Type: array
      • Items
      • $ref: ../../type/tagLabel.json
  • columnConstraint
    • Column level constraint.
    • $ref: #/definitions/columnConstraint
  • ordinalPosition
    • Ordinal position of the column.
    • Type: integer

columnJoins

• This schema defines the type to capture how frequently a column is joined with columns in the other tables.
• Type: object
• This schema does not accept additional properties.
• Properties
  • columnName
    • $ref: #/definitions/columnName
  • joinedWith
    • Fully qualified names of the columns that this column is joined with.
    • Type: array
      • Items
      • Type: object
      • Properties
        • fullyQualifiedName
          • $ref: #/definitions/fullyQualifiedColumnName
        • joinCount
          • Type: integer

tableJoins

• This schema defines the type to capture information about how columns in this table are joined with columns in the other tables.
• Type: object
• This schema does not accept additional properties.
• Properties
  • startDate
    • Date can be only from today going back to last 29 days.
    • $ref: ../../type/basic.json#/definitions/date
  • dayCount
    • Type: integer
    • Default: 1
  • columnJoins
    • Type: array
      • Items
      • $ref: #/definitions/columnJoins

tableData

• This schema defines the type to capture rows of sample data for a table.
• Type: object
• This schema does not accept additional properties.
• Properties
  • columns
    • List of local column names not fully qualified column names of the table.
    • Type: array
      • Items
      • $ref: #/definitions/columnName
  • rows
    • Data for multiple rows of the table.
    • Type: array
      • Items
      • Data for a single row of the table within the same order as columns fields.
      • Type: array