mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-14 04:29:21 +00:00

Sriharsha Chintalapani 876ac24e44

* GitBook: [#50] BigQuery, Glue, MSSQL, Postgres, Redshift, Snowflake - V2

* GitBook: [#62] No subject

* GitBook: [#63] No subject

* GitBook: [#64] Beta

* GitBook: [#65] Make Harsha's requested changes to connectors section organization

* GitBook: [#66] Kerberos authentication with Hive

* GitBook: [#67] Fix procedure overview links

* GitBook: [#68] Fix procedure overview links

* GitBook: [#69] correct step reference

* GitBook: [#70] Add Kerberos connection troubleshooting

* updated json schema and schema docs (#3219)

* updated json schema and schema docs

* added glossay to readme

* GitBook: [#72] Metrics & Tests

Co-authored-by: Parth Panchal <parth.panchal@deuexsolutions.com>
Co-authored-by: Shilpa V <vernekar.shilpa@gmail.com>
Co-authored-by: Shannon Bradshaw <shannon.bradshaw@arrikto.com>
Co-authored-by: parthp2107 <83201188+parthp2107@users.noreply.github.com>
Co-authored-by: pmbrull <peremiquelbrull@gmail.com>

2022-03-08 08:13:37 -08:00

5.3 KiB

Raw Blame History

Database

This schema defines the Database entity. A database also referred to as Database Catalog is a collection of tables.

$id:https://open-metadata.org/schema/entity/data/database.json

Type: object

This schema does not accept additional properties.

Properties

=======

id
- Unique identifier that identifies this database instance.
- $ref: ../../type/basic.json#/definitions/uuid
name required
- Name that identifies the database.
- $ref: #/definitions/databaseName
fullyQualifiedName
- Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
- Type: string
displayName
- Display Name that identifies this database.
- Type: string
description
- Description of the database instance.
- Type: string
version
- Metadata version of the entity.
- $ref: ../../type/entityHistory.json#/definitions/entityVersion
updatedAt
- Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
- $ref: ../../type/basic.json#/definitions/timestamp
updatedBy
- User who made the update.
- Type: string
href
- Link to the resource corresponding to this entity.
- $ref: ../../type/basic.json#/definitions/href
owner
- Owner of this database.
- $ref: ../../type/entityReference.json
service required
- Link to the database cluster/service where this database is hosted in.
- $ref: ../../type/entityReference.json
serviceType
- Service type where this database is hosted in.
- $ref: ../services/databaseService.json#/definitions/databaseServiceType
location
- Reference to the Location that contains this database.
- $ref: ../../type/entityReference.json
usageSummary
- Latest usage information for this database.
- $ref: ../../type/usageDetails.json
tables
- References to tables in the database.
- $ref: ../../type/entityReference.json#/definitions/entityReferenceList
changeDescription
- Change that lead to this version of the entity.
- $ref: ../../type/entityHistory.json#/definitions/changeDescription
deleted
- When true indicates the entity has been soft deleted.
- Type: boolean
- Default: false

id
- Unique identifier that identifies this database instance.
- $ref: ../../type/basic.json#/definitions/uuid
name required
- Name that identifies the database.
- $ref: #/definitions/databaseName
fullyQualifiedName
- Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
- Type: string
displayName
- Display Name that identifies this database.
- Type: string
description
- Description of the database instance.
- Type: string
version
- Metadata version of the entity.
- $ref: ../../type/entityHistory.json#/definitions/entityVersion
updatedAt
- Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
- $ref: ../../type/basic.json#/definitions/timestamp
updatedBy
- User who made the update.
- Type: string
href
- Link to the resource corresponding to this entity.
- $ref: ../../type/basic.json#/definitions/href
owner
- Owner of this database.
- $ref: ../../type/entityReference.json
service required
- Link to the database cluster/service where this database is hosted in.
- $ref: ../../type/entityReference.json
serviceType
- Service type where this database is hosted in.
- $ref: ../services/databaseService.json#/definitions/databaseServiceType
location
- Reference to the Location that contains this database.
- $ref: ../../type/entityReference.json
usageSummary
- Latest usage information for this database.
- $ref: ../../type/usageDetails.json
tables
- References to tables in the database.
- $ref: ../../type/entityReference.json#/definitions/entityReferenceList
changeDescription
- Change that lead to this version of the entity.
- $ref: ../../type/entityHistory.json#/definitions/changeDescription
deleted
- When true indicates the entity has been soft deleted.
- Type: boolean
- Default: false

Type definitions in this schema