2021-08-11 17:17:55 +00:00
# Database Service
2021-08-16 16:28:10 +00:00
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.
2021-08-11 17:17:55 +00:00
2021-08-13 15:48:38 +00:00
**$id:** [**https://open-metadata.org/schema/entity/services/databaseService.json** ](https://open-metadata.org/schema/entity/services/databaseService.json )
2021-08-11 17:17:55 +00:00
Type: `object`
## Properties
2021-08-13 15:48:38 +00:00
* **id** `required`
* Unique identifier of this database service instance.
2021-08-16 05:20:54 +00:00
* $ref: [../../type/basic.json\#/definitions/uuid ](../types/basic.md#types-definitions-in-this-schema )
2021-08-13 15:48:38 +00:00
* **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...
2021-08-16 05:20:54 +00:00
* $ref: [\#/definitions/databaseServiceType ](database-service.md#types-definitions-in-this-schema )
2021-08-13 15:48:38 +00:00
* **description**
* Description of a database service instance.
* Type: `string`
* **href** `required`
* Link to the resource corresponding to this database service.
2021-08-16 05:20:54 +00:00
* $ref: [../../type/basic.json\#/definitions/href ](../types/basic.md#types-definitions-in-this-schema )
2021-08-13 15:48:38 +00:00
* **jdbc** `required`
* JDBC connection information
2021-08-16 05:20:54 +00:00
* $ref: [../../type/jdbcConnection.json\#/definitions/jdbcInfo ](../types/jdbc-connection.md#types-definitions-in-this-schema )
2021-08-13 15:48:38 +00:00
* **ingestionSchedule**
* Schedule for running metadata ingestion jobs.
2021-08-16 05:20:54 +00:00
* $ref: [../../type/schedule.json ](../types/schedule.md )
2021-08-11 17:17:55 +00:00
## Types definitions in this schema
2021-08-13 15:48:38 +00:00
**databaseServiceType**
2021-08-13 08:26:20 -07:00
2021-08-13 15:48:38 +00:00
* 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"_
2021-08-11 17:17:55 +00:00