mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-28 03:40:04 +00:00
e2578d6be3
* GitBook: [#177] Documentation Update - Airflow * GitBook: [#195] Removing Cron from databaseServices * GitBook: [#196] Added trino * GitBook: [#197] removed cron from config * GitBook: [#198] Added Redash Documentation * GitBook: [#199] Added Bigquery Usage Documentation * GitBook: [#200] Added page link for presto * GitBook: [#201] Added Local Docker documentation * GitBook: [#202] Added Documentation for Local Docker Setup * GitBook: [#203] Added Git Command to clone Openmetadata in docs * GitBook: [#207] links update * GitBook: [#208] Updating Airflow Documentation * GitBook: [#210] Adding Python installation package under Airflow Lineage config * GitBook: [#211] Change the links to 0.5..0 * GitBook: [#213] Move buried connectors page up * GitBook: [#214] Update to connectors page * GitBook: [#215] Removed sub-categories * GitBook: [#212] Adding Discovery tutorial * GitBook: [#220] Updated steps to H2s. * GitBook: [#230] Complex queries * GitBook: [#231] Add lineage to feature overview * GitBook: [#232] Make feature overview headers verbs instead of nouns * GitBook: [#233] Add data reliability to features overview * GitBook: [#234] Add complex data types to feature overview * GitBook: [#235] Simplify and further distinguish discovery feature headers * GitBook: [#236] Add data importance to feature overview * GitBook: [#237] Break Connectors into its own section * GitBook: [#238] Reorganize first section of docs. * GitBook: [#239] Add connectors to feature overview * GitBook: [#240] Organize layout of feature overview into feature categories as agreed with Harsha. * GitBook: [#242] Make overview paragraph more descriptive. * GitBook: [#243] Create a link to Connectors section from feature overview. * GitBook: [#244] Add "discover data through association" to feature overview. * GitBook: [#245] Update importance and owners gifs * GitBook: [#246] Include a little more descriptive documentation for key features. * GitBook: [#248] Small tweaks to intro paragraph. * GitBook: [#249] Clean up data profiler paragraph. * GitBook: [#250] Promote Complex Data Types to its own feature. * GitBook: [#251] Update to advanced search * GitBook: [#252] Update Roadmap * GitBook: [#254] Remove old features page (text and screenshot based). * GitBook: [#255] Remove references to removed page. * GitBook: [#256] Add Descriptions and Tags section to feature overview. * GitBook: [#257] Update title for "Know Your Data" Co-authored-by: Ayush Shah <ayush.shah@deuexsolutions.com> Co-authored-by: Suresh Srinivas <suresh@getcollate.io> Co-authored-by: Shannon Bradshaw <shannon.bradshaw@arrikto.com> Co-authored-by: OpenMetadata <github@harsha.io>
67 lines
2.3 KiB
Markdown
67 lines
2.3 KiB
Markdown
# 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**](https://open-metadata.org/schema/entity/services/databaseService.json)
|
|
|
|
Type: `object`
|
|
|
|
## Properties
|
|
|
|
* **id** `required`
|
|
* Unique identifier of this database service instance.
|
|
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
|
|
* **name** `required`
|
|
* Name that identifies this database service.
|
|
* Type: `string`
|
|
* Length: between 1 and 64
|
|
* **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](databaseservice.md#databaseservicetype)
|
|
* **description**
|
|
* Description of a database service instance.
|
|
* Type: `string`
|
|
* **version**
|
|
* Metadata version of the entity.
|
|
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.md#entityversion)
|
|
* **updatedAt**
|
|
* Last update time corresponding to the new version of the entity.
|
|
* $ref: [../../type/basic.json#/definitions/dateTime](../types/basic.md#datetime)
|
|
* **updatedBy**
|
|
* User who made the update.
|
|
* Type: `string`
|
|
* **href** `required`
|
|
* Link to the resource corresponding to this database service.
|
|
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
|
|
* **jdbc** `required`
|
|
* JDBC connection information.
|
|
* $ref: [../../type/jdbcConnection.json#/definitions/jdbcInfo](../types/jdbcconnection.md#jdbcinfo)
|
|
* **ingestionSchedule**
|
|
* Schedule for running metadata ingestion jobs.
|
|
* $ref: [../../type/schedule.json](../types/schedule.md)
|
|
|
|
## 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"_
|
|
|
|
_This document was updated on: Monday, October 18, 2021_
|