mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-11-03 03:59:12 +00:00
16 KiB
16 KiB
Database Service Entity
databaseservice
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json
Database service entity that reference services such as MySQL, BigQuery, Redshift, Postgres or Snowflake
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | Yes | Unknown status | No | Forbidden | Allowed | none | databaseService.json |
Database service entity Type
object [Database service entity](databaseservice.md)
Database service entity Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| id | string |
Required | cannot be null | Basic type |
| name | string |
Required | cannot be null | Database service entity |
| serviceType | string |
Required | cannot be null | Database service entity |
| description | string |
Optional | cannot be null | Database service entity |
| href | string |
Required | cannot be null | Basic type |
| jdbc | object |
Required | cannot be null | Jdbc Connection type |
| ingestionSchedule | object |
Optional | cannot be null | Schedule type |
id
Unique id used to identify an entity
id
- is required
- Type:
string - cannot be null
- defined in: Basic type
id Type
string
id Constraints
UUID: the string must be a UUID, according to RFC 4122
name
Name that identifies the this entity instance uniquely. Same as id if when name is not unique
name
- is required
- Type:
string - cannot be null
- defined in: Database service entity
name Type
string
name Constraints
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
serviceType
Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
serviceType
- is required
- Type:
string - cannot be null
- defined in: Database service entity
serviceType Type
string
serviceType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"BigQuery" |
|
"MySQL" |
|
"Redshift" |
|
"Snowflake" |
|
"Postgres" |
|
"MSSQL" |
|
"Hive" |
description
Description of database service instance.
description
- is optional
- Type:
string - cannot be null
- defined in: Database service entity
description Type
string
href
Link to the resource corresponding to this entity
Link to the resource
href
- is required
- Type:
string - cannot be null
- defined in: Basic type
href Type
string
href Constraints
URI: the string must be a URI, according to RFC 3986
jdbc
Type for capturing JDBC connector information
jdbc
- is required
- Type:
object[Details](../types/jdbcconnection.md#jdbcconnection-definitions-jdbcinfo) - cannot be null
- defined in: Jdbc Connection type
jdbc Type
object [Details](../types/jdbcconnection.md#jdbcconnection-definitions-jdbcinfo)
ingestionSchedule
Type used for schedule with start time and repeat frequency
ingestionSchedule
- is optional
- Type:
object[Type used for schedule with start time and repeat frequency](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/schedule.md) - cannot be null
- defined in: Schedule type
ingestionSchedule Type
object [Type used for schedule with start time and repeat frequency](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/schedule.md)
Database service entity Definitions
Definitions group databaseServiceType
Reference this group by using
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/definitions/databaseServiceType"}
| Property | Type | Required | Nullable | Defined by |
|---|
databaseservice-definitions-databaseservicetype-javaenums-0
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/definitions/databaseServiceType/javaEnums/0
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | databaseService.json* |
0 Type
unknown
databaseservice-definitions-databaseservicetype-javaenums-1
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/definitions/databaseServiceType/javaEnums/1
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | databaseService.json* |
1 Type
unknown
databaseservice-definitions-databaseservicetype-javaenums-2
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/definitions/databaseServiceType/javaEnums/2
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | databaseService.json* |
2 Type
unknown
databaseservice-definitions-databaseservicetype-javaenums-3
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/definitions/databaseServiceType/javaEnums/3
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | databaseService.json* |
3 Type
unknown
databaseservice-definitions-databaseservicetype-javaenums-4
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/definitions/databaseServiceType/javaEnums/4
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | databaseService.json* |
4 Type
unknown
databaseservice-definitions-databaseservicetype-javaenums-5
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/definitions/databaseServiceType/javaEnums/5
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | databaseService.json* |
5 Type
unknown
databaseservice-definitions-databaseservicetype-javaenums-6
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/definitions/databaseServiceType/javaEnums/6
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | databaseService.json* |
6 Type
unknown
databaseservice-definitions-databaseservicetype
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/services/createDatabaseService.json#/properties/serviceType
Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | createDatabaseService.json* |
serviceType Type
string
serviceType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"BigQuery" |
|
"MySQL" |
|
"Redshift" |
|
"Snowflake" |
|
"Postgres" |
|
"MSSQL" |
|
"Hive" |
databaseservice-definitions
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/definitions
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | databaseService.json* |
definitions Type
unknown
databaseservice-properties-description
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/properties/description
Description of database service instance.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | databaseService.json* |
description Type
string
databaseservice-properties-name
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/properties/name
Name that identifies the this entity instance uniquely. Same as id if when name is not unique
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | databaseService.json* |
name Type
string
name Constraints
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
databaseservice-properties-servicetype
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/properties/serviceType
Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | databaseService.json* |
serviceType Type
string
serviceType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"BigQuery" |
|
"MySQL" |
|
"Redshift" |
|
"Snowflake" |
|
"Postgres" |
|
"MSSQL" |
|
"Hive" |