mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-10-31 10:39:30 +00:00
38 lines
2.6 KiB
Markdown
38 lines
2.6 KiB
Markdown
|
---
|
||
|
|
title: createTable
|
||
|
|
slug: /main-concepts/metadata-standard/schemas/api/data/createtable
|
||
|
|
---
|
||
|
|
|
||
|
|
# CreateTableRequest
|
||
|
|
|
||
|
|
*Schema corresponding to a table that belongs to a database*
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
- **`name`**: Name that identifies the this entity instance uniquely. Same as id if when name is not unique. Refer to *../../entity/data/table.json#/definitions/entityName*.
|
||
|
|
- **`displayName`** *(string)*: Display Name that identifies this table.
|
||
|
|
- **`description`**: Description of entity instance. Refer to *../../type/basic.json#/definitions/markdown*.
|
||
|
|
- **`tableType`**: Refer to *../../entity/data/table.json#/definitions/tableType*.
|
||
|
|
- **`columns`** *(array)*: Name of the tables in the database. Default: `None`.
|
||
|
|
- **Items**: Refer to *../../entity/data/table.json#/definitions/column*.
|
||
|
|
- **`tableConstraints`** *(array)*: Default: `None`.
|
||
|
|
- **Items**: Refer to *../../entity/data/table.json#/definitions/tableConstraint*.
|
||
|
|
- **`tablePartition`**: Refer to *../../entity/data/table.json#/definitions/tablePartition*.
|
||
|
|
- **`tableProfilerConfig`**: Refer to *../../entity/data/table.json#/definitions/tableProfilerConfig*.
|
||
|
|
- **`owner`**: Owner of this entity. Refer to *../../type/entityReference.json*. Default: `None`.
|
||
|
|
- **`databaseSchema`**: FullyQualified name of the Schema corresponding to this table. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
|
||
|
|
- **`tags`** *(array)*: Tags for this table. Default: `None`.
|
||
|
|
- **Items**: Refer to *../../type/tagLabel.json*.
|
||
|
|
- **`viewDefinition`**: View Definition in SQL. Applies to TableType.View only. Refer to *../../type/basic.json#/definitions/sqlQuery*. Default: `None`.
|
||
|
|
- **`retentionPeriod`**: Retention period of the data in the database. Period is expressed as duration in ISO 8601 format in UTC. Example - `P23DT23H`. Refer to *../../type/basic.json#/definitions/duration*.
|
||
|
|
- **`extension`**: Entity extension data with custom attributes added to the entity. Refer to *../../type/basic.json#/definitions/entityExtension*.
|
||
|
|
- **`sourceUrl`**: Source URL of table. Refer to *../../type/basic.json#/definitions/sourceUrl*.
|
||
|
|
- **`domain`** *(string)*: Fully qualified name of the domain the Table belongs to.
|
||
|
|
- **`dataProducts`** *(array)*: List of fully qualified names of data products this entity is part of.
|
||
|
|
- **Items**: Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
|
||
|
|
- **`fileFormat`**: File format in case of file/datalake tables. Refer to *../../entity/data/table.json#/definitions/fileFormat*.
|
||
|
|
- **`lifeCycle`**: Life Cycle of the entity. Refer to *../../type/lifeCycle.json*.
|
||
|
|
|
||
|
|
|
||
|
|
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
|