json.schema.api.data.createTable.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmetadata-core Show documentation
The newest version!
{
  "$id": "https://open-metadata.org/schema/api/data/createTable.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateTableRequest",
  "description": "Schema corresponding to a table that belongs to a database",
  "type": "object",
  "javaType": "org.openmetadata.catalog.api.data.CreateTable",
  "javaInterfaces": ["org.openmetadata.core.entity.interfaces.CreateEntity"],

  "properties": {
    "name": {
      "description": "Name that identifies the this entity instance uniquely. Same as id if when name is not unique",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this table.",
      "type": "string"
    },
    "description": {
      "description": "Description of entity instance.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "tableType": {
      "$ref": "../../entity/data/table.json#/definitions/tableType"
    },
    "columns": {
      "description": "Name of the tables in the database",
      "type": "array",
      "items": {
        "$ref": "../../entity/data/table.json#/definitions/column"
      },
      "default": null
    },
    "tableConstraints": {
      "type": "array",
      "items": {
        "$ref": "../../entity/data/table.json#/definitions/tableConstraint"
      },
      "default": null
    },
    "tablePartition": {
      "$ref": "../../entity/data/table.json#/definitions/tablePartition"
    },
    "profileSample": {
      "description": "Percentage of data we want to execute the profiler and tests on. Represented in the range (0, 100].",
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 100,
      "default": null
    },
    "profileQuery": {
      "description": "Users' raw SQL query to fetch sample data and profile the table",
      "type": "string",
      "default": null
    },
    "owner": {
      "description": "Owner of this entity",
      "$ref": "../../type/entityReference.json",
      "default": null
    },
    "databaseSchema": {
      "description": "Schema corresponding to this table",
      "$ref": "../../type/entityReference.json",
      "default": null
    },
    "tags": {
      "description": "Tags for this table",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": null
    },
    "viewDefinition": {
      "description": "View Definition in SQL. Applies to TableType.View only",
      "$ref": "../../type/basic.json#/definitions/sqlQuery",
      "default": null
    },
    "extension": {
      "description": "Entity extension data with custom attributes added to the entity.",
      "$ref": "../../type/basic.json#/definitions/entityExtension"
    }
  },
  "required": ["name", "columns", "databaseSchema"],
  "additionalProperties": false
}