yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-23 17:30:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/docs/openmetadata-apis/schemas/entities/table.md
parthp2107 13be70e416
updated documentation (#508) 
* updated documentation

* addressing pyline findings

* addressing pyline findings

* doc update

Co-authored-by: parthp2107 <parth@getcollate.io>
2021-09-18 20:13:31 -07:00

8.9 KiB
Raw Blame History

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://open-metadata.org/schema/entity/data/table.json

Type: object

Properties

Type 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

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
    • joinedWith
      • Fully qualified names of the columns that this column is joined with.
      • Type: array
        • Items
        • Type: object
  • Properties

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

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

columnProfile

  • This schema defines the type to capture the table's column profile.
  • Type: object
  • Properties
    • name
      • Column Name.
      • Type: string
    • uniqueCount
      • No. of unique values in the column.
      • Type: number
    • uniqueProportion
      • Proportion of number of unique values in a column.
      • Type: number
    • nullCount
      • No.of null values in a column.
      • Type: number
    • nullProportion
      • No.of null value proportion in columns.
      • Type: number
        • min
          • Minimum value in a column.
          • Type: string
        • max
          • Maximum value in a column.
          • Type: string
        • mean
          • Avg value in a column.
          • Type: string
        • median
          • Median value in a column.
          • Type: string
        • stddev
          • Standard deviation of a column.
          • Type: number

tableProfile

  • This schema defines the type to capture the table's data profile.
  • Type: object
  • This schema does not accept additional properties.

This document was updated on: Thursday, September 16, 2021