mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-10 10:40:42 +00:00
2.5 KiB
2.5 KiB
Database Service
This schema defines the Database Service entity, such as MySQL, BigQuery, Redshift, Postgres, or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used for database service.
$id:https://open-metadata.org/schema/entity/services/databaseService.json
Type: object
Properties
- id
required
- Unique identifier of this database service instance.
- $ref: ../../type/basic.json#/definitions/uuid
- name
required
- Name that identifies this database service.
- Type:
string
- Length: between 1 and 64
- displayName
- Display Name that identifies this database service.
- Type:
string
- serviceType
required
- Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
- $ref: #/definitions/databaseServiceType
- description
- Description of a database service instance.
- Type:
string
- version
- Metadata version of the entity.
- $ref: ../../type/entityHistory.json#/definitions/entityVersion
- updatedAt
- Last update time corresponding to the new version of the entity.
- $ref: ../../type/basic.json#/definitions/dateTime
- updatedBy
- User who made the update.
- Type:
string
- href
required
- Link to the resource corresponding to this database service.
- $ref: ../../type/basic.json#/definitions/href
- jdbc
required
- JDBC connection information.
- $ref: ../../type/jdbcConnection.json#/definitions/jdbcInfo
- ingestionSchedule
- Schedule for running metadata ingestion jobs.
- $ref: ../../type/schedule.json
- changeDescription
- Change that lead to this version of the entity.
- $ref: ../../type/entityHistory.json#/definitions/changeDescription
Type definitions in this schema
databaseServiceType
- Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
- Type:
string
- The value is restricted to the following:
- "BigQuery"
- "MySQL"
- "Redshift"
- "Snowflake"
- "Postgres"
- "MSSQL"
- "Hive"
- "Oracle"
- "Athena"
- "Presto"
- "Trino"
- "Vertica"
- "Glue"
This document was updated on: Monday, November 15, 2021