json.schema.api.data.createTable.json Maven / Gradle / Ivy
{
"$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.schema.api.data.CreateTable",
"javaInterfaces": ["org.openmetadata.schema.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
},
"dataModel": {
"$ref": "../../entity/data/table.json#/definitions/dataModel"
},
"tableConstraints": {
"type": "array",
"items": {
"$ref": "../../entity/data/table.json#/definitions/tableConstraint"
},
"default": null
},
"tablePartition": {
"$ref": "../../entity/data/table.json#/definitions/tablePartition"
},
"tableProfilerConfig": {
"$ref": "../../entity/data/table.json#/definitions/tableProfilerConfig"
},
"owners": {
"description": "Owners of this entity",
"$ref": "../../type/entityReferenceList.json",
"default": null
},
"databaseSchema": {
"description": "FullyQualified name of the Schema corresponding to this table",
"$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
},
"tags": {
"description": "Tags for this table",
"type": "array",
"items": {
"$ref": "../../type/tagLabel.json"
},
"default": null
},
"schemaDefinition": {
"description": "DDL for Tables and Views",
"$ref": "../../type/basic.json#/definitions/sqlQuery",
"default": null
},
"retentionPeriod" : {
"description": "Retention period of the data in the database. Period is expressed as duration in ISO 8601 format in UTC. Example - `P23DT23H`.",
"$ref": "../../type/basic.json#/definitions/duration"
},
"extension": {
"description": "Entity extension data with custom attributes added to the entity.",
"$ref": "../../type/basic.json#/definitions/entityExtension"
},
"sourceUrl": {
"description": "Source URL of table.",
"$ref": "../../type/basic.json#/definitions/sourceUrl"
},
"domain" : {
"description": "Fully qualified name of the domain the Table belongs to.",
"type": "string"
},
"dataProducts" : {
"description": "List of fully qualified names of data products this entity is part of.",
"type": "array",
"items" : {
"$ref" : "../../type/basic.json#/definitions/fullyQualifiedEntityName"
}
},
"fileFormat": {
"description": "File format in case of file/datalake tables.",
"$ref": "../../entity/data/table.json#/definitions/fileFormat"
},
"lifeCycle": {
"description": "Life Cycle of the entity",
"$ref": "../../type/lifeCycle.json"
},
"sourceHash": {
"description": "Source hash of the entity",
"type": "string",
"minLength": 1,
"maxLength": 32
}
},
"required": ["name", "columns", "databaseSchema"],
"additionalProperties": false
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy