OpenMetadata/openmetadata-docs/content/v1.7.x/main-concepts/metadata-standard/schemas/api/data/createDatabase.md

title	slug
Create Database API | OpenMetadata Database API	/main-concepts/metadata-standard/schemas/api/data/createdatabase

CreateDatabaseRequest

Create Database entity request

Properties

• name: Name that identifies this database instance uniquely. Refer to ../../type/basic.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: null.
  • Items: Refer to ../../type/tagLabel.json.
• owners: Owners of this database. Refer to ../../type/entityReferenceList.json. Default: null.
• service: Link to the database service fully qualified name where this database is hosted in. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
• dataProducts (array): List of fully qualified names of data products this entity is part of.
  • Items: 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.
• sourceHash (string): Source hash of the entity.

Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.