mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-13 12:08:47 +00:00
28 lines
1.8 KiB
Markdown
28 lines
1.8 KiB
Markdown
![]() |
---
|
||
|
title: createDatabase
|
||
|
slug: /main-concepts/metadata-standard/schemas/api/data/createdatabase
|
||
|
---
|
||
|
|
||
|
# CreateDatabaseRequest
|
||
|
|
||
|
*Create Database entity request*
|
||
|
|
||
|
## Properties
|
||
|
|
||
|
- **`name`**: Name that identifies this database instance uniquely. Refer to *../../entity/data/database.json#/definitions/entityName*.
|
||
|
- **`displayName`** *(string)*: Display Name that identifies this database.
|
||
|
- **`description`**: Description of the database instance. What it has and how to use it. Refer to *../../type/basic.json#/definitions/markdown*.
|
||
|
- **`tags`** *(array)*: Tags for this Database Service. Default: `None`.
|
||
|
- **Items**: Refer to *../../type/tagLabel.json*.
|
||
|
- **`owner`**: Owner of this database. Refer to *../../type/entityReference.json*.
|
||
|
- **`service`**: Link to the database service fully qualified name where this database is hosted in. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
|
||
|
- **`default`** *(boolean)*: Some databases don't support a database/catalog in the hierarchy and use default database. For example, `MySql`. For such databases, set this flag to true to indicate that this is a default database. Default: `False`.
|
||
|
- **`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 database. Refer to *../../type/basic.json#/definitions/sourceUrl*.
|
||
|
- **`domain`** *(string)*: Fully qualified name of the domain the Database belongs to.
|
||
|
- **`lifeCycle`**: Life Cycle of the entity. Refer to *../../type/lifeCycle.json*.
|
||
|
|
||
|
|
||
|
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
|