databaseservice.md

layout	title
default	Database Service

databaseservice

Database service entity Schema

https://github.com/StreamlineData/catalog/blob/master/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json

Database service entity that reference services such as MySQL, BigQuery, Redshift 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)

Database service entity Properties

Property	Type	Required	Nullable	Defined by
id	string	Required	cannot be null	Database service entity
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	Database service entity
jdbc	object	Required	cannot be null	Database service entity
ingestionSchedule	object	Optional	cannot be null	Database service entity

id

Unique id used to identify an entity

id

• is required
• Type: string
• cannot be null
• defined in: Database service entity

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...

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"

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: Database service entity

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)
• cannot be null
• defined in: Database service entity

jdbc Type

object (Details)

ingestionSchedule

Schedule for running metadata ingestion jobs

ingestionSchedule

• is optional
• Type: object (Details)
• cannot be null
• defined in: Database service entity

ingestionSchedule Type

object (Details)

Database service entity Definitions

Definitions group databaseServiceType

Reference this group by using

{"$ref":"https://github.com/StreamlineData/catalog/blob/master/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json#/definitions/databaseServiceType"}

Property	Type	Required	Nullable	Defined by