-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add description of Unity Catalog support
Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>
- Loading branch information
1 parent
ff30ee9
commit 19b52bf
Showing
31 changed files
with
5,356 additions
and
404 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,135 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the Egeria project. --> | ||
|
||
|
||
# Unity Catalog | ||
|
||
---8<-- "snippets/systems/unity-catalog-intro.md" | ||
|
||
The picture below shows Unity Catalog managing access to data in [Delta Lake](https://delta.io/). | ||
|
||
![Unity Lake with Delta Lake](unity-catalog-purpose.svg) | ||
|
||
Internally, unity catalog's metadata is organized into catalogs. (So one way to think of Unity Catalog is as a 'catalog of catalogs'.) Each catalog has multiple schemas and these contain the resources: | ||
|
||
* Tables - these are virtual tables, typically backed by an Apache Parquet file. | ||
* Functions - these are callable functions, typically implemented in SQL, but may be a callable external component. | ||
* Volumes - these are collections of files. | ||
|
||
As a result of this structure, the resources in Unity Catalog have a three level name: *catalogName.schemaName.resourceName*. | ||
|
||
## Unity Catalog Technology Type Names | ||
|
||
The technology type names (aka [deployed implementation types](/concepts/deployed-implementation-type)) added to Egeria's reference data for Unity Catalog are: | ||
|
||
* *Unity Catalog Server* - The OSS Unity Catalog (UC) Server is an operational data platform 'catalog of catalogs' that supports controlled access to data managed through a related data platforms. | ||
* *Unity Catalog Catalog* - An operational data platform catalog within the Unity Catalog (UC) 'catalog of catalogs'. | ||
* *Unity Catalog Schema* - A schema that organizes data assets for an operational data platform catalog within the Unity Catalog (UC) 'catalog of catalogs'. | ||
* *Unity Catalog Table* - A relational table within the Unity Catalog (UC) 'catalog of catalogs'. | ||
* *Unity Catalog Function* - A function found in Unity Catalog (UC) that is working with data. | ||
* *Unity Catalog Volume* - A collection of related data files within the Unity Catalog (UC) 'catalog of catalogs'. | ||
|
||
??? example "JSON output from tech type search for 'Unity Catalog'" | ||
```json | ||
{ | ||
"class": "TechnologyTypeSummaryListResponse", | ||
"relatedHTTPCode": 200, | ||
"elements": [ | ||
{ | ||
"technologyTypeGUID": "2d89345f-2650-4c04-bd5c-8cdbab7a0b79", | ||
"qualifiedName": "Egeria:ValidMetadataValue:SoftwareServer:deployedImplementationType-(Unity Catalog Server)", | ||
"name": "Unity Catalog Server", | ||
"description": "The OSS Unity Catalog (UC) Server is an operational data platform 'catalog of catalogs' that supports controlled access to data managed through a related data platforms.", | ||
"category": "SoftwareServer:deployedImplementationType" | ||
}, | ||
{ | ||
"technologyTypeGUID": "2b28dd27-3d4e-4c75-a3e8-cbbcbe8cb62f", | ||
"qualifiedName": "Egeria:ValidMetadataValue:Catalog:deployedImplementationType-(Unity Catalog Catalog)", | ||
"name": "Unity Catalog Catalog", | ||
"description": "An operational data platform catalog within the Unity Catalog (UC) 'catalog of catalogs'.", | ||
"category": "Catalog:deployedImplementationType" | ||
}, | ||
{ | ||
"technologyTypeGUID": "c56ca4d1-ed5a-4b05-b75b-e4b6bd3500ff", | ||
"qualifiedName": "Egeria:ValidMetadataValue:DeployedDatabaseSchema:deployedImplementationType-(Unity Catalog Schema)", | ||
"name": "Unity Catalog Schema", | ||
"description": "A schema that organizes data assets for an operational data platform catalog within the Unity Catalog (UC) 'catalog of catalogs'.", | ||
"category": "DeployedDatabaseSchema:deployedImplementationType" | ||
}, | ||
{ | ||
"technologyTypeGUID": "3a1ad610-f5c5-4aba-a766-63965ac528be", | ||
"qualifiedName": "Egeria:ValidMetadataValue:VirtualRelationalTable:deployedImplementationType-(Unity Catalog Table)", | ||
"name": "Unity Catalog Table", | ||
"description": "A relational table within the Unity Catalog (UC) 'catalog of catalogs'.", | ||
"category": "VirtualRelationalTable:deployedImplementationType" | ||
}, | ||
{ | ||
"technologyTypeGUID": "7f15dd5f-7569-4697-a3f1-491e399f4351", | ||
"qualifiedName": "Egeria:ValidMetadataValue:DeployedAPI:deployedImplementationType-(Unity Catalog Function)", | ||
"name": "Unity Catalog Function", | ||
"description": "A function found in Unity Catalog (UC) that is working with data.", | ||
"category": "DeployedAPI:deployedImplementationType" | ||
}, | ||
{ | ||
"technologyTypeGUID": "dbabe8cb-345e-4665-a665-1bef56a26ecd", | ||
"qualifiedName": "Egeria:ValidMetadataValue:DataFolder:deployedImplementationType-(Unity Catalog Volume)", | ||
"name": "Unity Catalog Volume", | ||
"description": "A collection of related data files within the Unity Catalog (UC) 'catalog of catalogs'.", | ||
"category": "DataFolder:deployedImplementationType" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
## Open Metadata Type Mapping for Unity Catalog | ||
|
||
The mapping from Unity Catalog metadata elements to the Open Metadata Types used in the Open Metadata Ecosystem is as follows: | ||
|
||
| Technology Type | Open Metadata Type | | ||
|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| Unity Catalog Server | [SoftwareServer](/types/0/0040-Software-Servers) | | ||
| Unity Catalog Catalog | [Catalog](/types/0/0050-Applications-and-Processes) | | ||
| Unity Catalog Schema | [DeployedDatabaseSchema](/types/2/0224-Databases) | | ||
| Unity Catalog Function | [DeployedAPI](/types/2/0212-Deployed-APIs) with an associated [DeployedSoftwareComponent](/types/2/0215-Software-Components) for its implementation. | | ||
| Unity Catalog Table | [VirtualRelationalTable](/types/2/0235-Information-View) with an associated [DataFolder](/types/2/0220-Files-and-Folders) for its files. | | ||
| Unity Catalog Volume | [DataFolder](/types/2/0220-Files-and-Folders) | | ||
|
||
In addition, each of these elements have a [PropertyFacet](/types/0/0020-Property-Facets) and an [External Identifier](/types/0/0017-External-Identifiers) attached. The property facet contains implementation specific details; the external identifier includes the guid from unity catalog plus other mapping values such as the catalog name, schema name and short name to enable the Unity Catalog connectors to ensure that the name of a element has not changed since the last time a Unity Catalog element was retrieved. | ||
|
||
The diagram below illustrates the mapping of the Unity Catalog metadata resource to the Open Metadata Types. | ||
|
||
![Type Mapping](unity-catalog-type-mapping.svg) | ||
|
||
The templates that implement this mapping are described in [Unity Catalog Templates](/templates/unity-catalog-templates). | ||
|
||
### Anchor design for Unity Catalog | ||
|
||
In order to have correct delete semantics, each of the unity catalog resources is its own [anchored structure](/concepts/anchor). In addition, each resource is anchored to its parent. So each table, function and volume is anchored to its schema and each schema is anchored to its catalog. The catalogs are anchored to their appropriate server. | ||
|
||
The result is, if for example, a catalog is deleted, all the schemas, tables, functions and volumes nested underneath it are deleted too - ensuring there are no orphaned fragments of metadata left in the repository. | ||
|
||
### Metadata Collections | ||
|
||
Each catalog in a Unity Catalog server is assigned its own metadata collection. The schemas, tables, functions and volumes within the catalog are all part of the catalog's metadata collection making it easy to identify the origin of these metadata elements. | ||
|
||
![Metadata Collections for Unity Catalog Resources](unity-catalog-metadata-collections.svg) | ||
|
||
The unity connectors also use the metadata collections to scope the metadata they are processing. | ||
|
||
## Unity Catalog Connectors | ||
|
||
The connectors shipped with Egeria are as follows: | ||
|
||
![Unity Catalog Connectors](unity-catalog-connectors.svg) | ||
|
||
| Connector Name | Connector Type | Purpose | | ||
|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| [Unity Catalog Resource Connector](/connector/unity-catalog/resource-connector) | [Digital Resource Connector](/concepts/digital-resource-connector) | Provides wrapper around Unity Catalog's REST API. | | ||
| [Unity Catalog Server Survey](/connector/unity-catalog/server-survey-service) | [Survey Action Service](/concepts/survey-action-service) | Surveys the contents of a Unity Catalog Server. | | ||
| [Unity Catalog Catalog Survey](/connector/unity-catalog/catalog-survey-service) | [Survey Action Service](/concepts/survey-action-service) | Surveys the contents of a Unity Catalog Catalog. | | ||
| [Unity Catalog Schema Survey](/connector/unity-catalog/schema-survey-service) | [Survey Action Service](/concepts/survey-action-service) | Surveys the contents of a Unity Catalog Schema. | | ||
| [Unity Catalog Server Synchronizer](/connector/unity-catalog/sync-server-connector) | [Integration Connector](/concepts/integration-connector) | Bootstraps the cataloguing of a Unity Catalog Server by retrieving the catalogs and configuring the Inside Catalog Connector (below). | | ||
| [Unity Catalog Inside Catalog Synchronizer](/connector/unity-catalog/sync-catalog-connector) | [Integration Connector](/concepts/integration-connector) | Synchronizes the metadata describing a Unity Catalog Server's catalogs, schemas, tables, functions and volumes between Unity Catalog and the Open Metadata Ecosystem. | | ||
|
||
|
||
--8<-- "snippets/abbr.md" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the Egeria project. --> | ||
|
||
# OSS Unity Catalog Schema Survey Service | ||
|
||
Survey of a schema within an OSS Unity Catalog Server. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions
4
site/docs/connectors/unity-catalog/unity-catalog-connectors.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions
4
site/docs/connectors/unity-catalog/unity-catalog-metadata-collections.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions
4
site/docs/connectors/unity-catalog/unity-catalog-type-mapping.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.