OpenMetadata/docs/openmetadata-apis/schemas/entities/database-service.md

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.

$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/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
• 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
• 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

Types 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:
  1. "BigQuery"
  2. "MySQL"
  3. "Redshift"
  4. "Snowflake"
  5. "Postgres"
  6. "MSSQL"
  7. "Hive"