OpenMetadata/docs/openmetadata-apis/schemas/entities/databaseservice.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 for database service.

$id:https://open-metadata.org/schema/entity/services/databaseService.json

Type: object

This schema does not accept additional properties.

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
  • The value must match this pattern: ^[^.]*$
  • Length: between 1 and 128
• 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
• databaseConnection required
  • $ref: #/definitions/databaseConnection
• airflowPipelines
  • References to airflow pipelines deployed for this database service.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• version
  • Metadata version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
  • $ref: ../../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • Type: string
• owner
  • Owner of this database service.
  • $ref: ../../type/entityReference.json
• href required
  • Link to the resource corresponding to this database service.
  • $ref: ../../type/basic.json#/definitions/href
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false

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:
  1. "BigQuery"
  2. "MySQL"
  3. "Redshift"
  4. "Snowflake"
  5. "Postgres"
  6. "MSSQL"
  7. "Hive"
  8. "Oracle"
  9. "Athena"
  10. "Presto"
  11. "Trino"
  12. "Vertica"
  13. "Glue"
  14. "MariaDB"
  15. "Druid"
  16. "Db2"
  17. "ClickHouse"
  18. "Databricks"
  19. "DynamoDB"
  20. "AzureSQL"
  21. "SingleStore"
  22. "SQLite"

databaseConnection

• Database Connection.
• Type: object
• This schema does not accept additional properties.
• Properties
  • username
    • username to connect to the data source.
    • Type: string
  • password
    • password to connect to the data source.
    • Type: string
  • hostPort
    • Host and port of the data source.
    • Type: string
  • database
    • Database of the data source.
    • Type: string
  • connectionOptions
    • Additional connection options that can be sent to service during the connection.
    • Type: object
  • connectionArguments
    • Additional connection arguments such as security or protocol configs that can be sent to service during connection.
    • Type: object

This document was updated on: Wednesday, March 9, 2022