mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-11-04 12:36:23 +00:00
39 lines
3.2 KiB
Markdown
39 lines
3.2 KiB
Markdown
|
---
|
||
|
|
title: databaseService
|
||
|
|
slug: /main-concepts/metadata-standard/schemas/entity/services/databaseservice
|
||
|
|
---
|
||
|
|
|
||
|
|
# Database Service
|
||
|
|
|
||
|
|
*This schema defines the `Database Service` is a service such as MySQL, BigQuery, Redshift, Postgres, or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used for database service.*
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
- **`id`**: Unique identifier of this database service instance. Refer to *../../type/basic.json#/definitions/uuid*.
|
||
|
|
- **`name`**: Name that identifies this database service. Refer to *../../type/basic.json#/definitions/entityName*.
|
||
|
|
- **`fullyQualifiedName`**: FullyQualifiedName same as `name`. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
|
||
|
|
- **`displayName`** *(string)*: Display Name that identifies this database service.
|
||
|
|
- **`serviceType`**: Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres... Refer to *#/definitions/databaseServiceType*.
|
||
|
|
- **`description`**: Description of a database service instance. Refer to *../../type/basic.json#/definitions/markdown*.
|
||
|
|
- **`connection`**: Refer to *#/definitions/databaseConnection*.
|
||
|
|
- **`pipelines`**: References to pipelines deployed for this database service to extract metadata, usage, lineage etc.. Refer to *../../type/entityReferenceList.json#/definitions/entityReferenceList*.
|
||
|
|
- **`testConnectionResult`**: Last test connection results for this service. Refer to *connections/testConnectionResult.json*.
|
||
|
|
- **`tags`** *(array)*: Tags for this Database Service. Default: `None`.
|
||
|
|
- **Items**: Refer to *../../type/tagLabel.json*.
|
||
|
|
- **`version`**: Metadata version of the entity. Refer to *../../type/entityHistory.json#/definitions/entityVersion*.
|
||
|
|
- **`updatedAt`**: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to *../../type/basic.json#/definitions/timestamp*.
|
||
|
|
- **`updatedBy`** *(string)*: User who made the update.
|
||
|
|
- **`owner`**: Owner of this database service. Refer to *../../type/entityReference.json*.
|
||
|
|
- **`href`**: Link to the resource corresponding to this database service. Refer to *../../type/basic.json#/definitions/href*.
|
||
|
|
- **`changeDescription`**: Change that lead to this version of the entity. Refer to *../../type/entityHistory.json#/definitions/changeDescription*.
|
||
|
|
- **`deleted`** *(boolean)*: When `true` indicates the entity has been soft deleted. Default: `False`.
|
||
|
|
- **`domain`**: Domain the Database service belongs to. Refer to *../../type/entityReference.json*.
|
||
|
|
## Definitions
|
||
|
|
|
||
|
|
- **`databaseServiceType`** *(string)*: Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres... Must be one of: `['BigQuery', 'Mysql', 'Redshift', 'Snowflake', 'Postgres', 'Mssql', 'Oracle', 'Athena', 'Hive', 'Impala', 'Presto', 'Trino', 'Vertica', 'Glue', 'MariaDB', 'Druid', 'Db2', 'Clickhouse', 'Databricks', 'AzureSQL', 'DynamoDB', 'SingleStore', 'SQLite', 'DeltaLake', 'Salesforce', 'PinotDB', 'Datalake', 'DomoDatabase', 'QueryLog', 'CustomDatabase', 'Dbt', 'SapHana', 'MongoDB']`.
|
||
|
|
- **`databaseConnection`** *(object)*: Database Connection. Cannot contain additional properties.
|
||
|
|
- **`config`**
|
||
|
|
|
||
|
|
|
||
|
|
Documentation file automatically generated at 2023-07-07 05:50:35.981927.
|