Skip to content

This component is complete and can be used. The interfaces will be supported until the function is removed from the project via the deprecation process. There will be ongoing extensions to this function, but it will be done to ensure backward compatibility as far as possible. If there is a need to break backward compatibility, this will be discussed and reviewed in the community, with a documented timeline.

Database Integrator Open Metadata Integration Service (OMIS)

The Database Integrator OMIS supports the exchange of data assets and their related schema and connection information between an external relational database manager and the open metadata ecosystem.

It supports a type of integration connector that are able to create Database and DeployedDatabaseSchema assets along with is associated tables and columns. Optionally, this metadata can be tied to a Database Manager also known as a Database Management System (DBMS).

Figure 1 shows the types of metadata that integrators connectors can create with this integration service.

Figure 1

Figure 1: Database metadata supported by the Database Integrator OMIS

The structure of a database schema consist of a number of database tables and database views. The difference is that the database table has its values stored in the database whereas the database view is a set of values that are derived from accessing other database tables using a query.

The structure of both the database tables and database views are describes by database columns.

Database columns have a types that represent a single value. This can be stored, or derived using a query. If the column presents the unique for a row within the table, it can be decorated with the PrimaryKey classification. If a column contains values that are the primary key of another table then the two columns can be linked using the ForeignKey relationship.

Figure 2 shows the open metadata types used to represent the metadata created through this service.

Figure 2

Figure 2: Database open metadata types supported by the Database Integrator OMIS

A database schema is represented using the DeployedDatabaseSchema entity, the database table is represented using the RelationalTable entity and the database column is represented using the RelationalColumn entity. A database view is a RelationalTable entity with the Calculated Value classification attached.

If a DatabaseManager is defined, any Database created is automatically linked to it using the ServerAssetUse relationship. When a DeployedDatabaseSchema is created for the Database, the service automatically inserts the DataContentForDataSet relationship. (The database schema is a DataSet over the database which is a type of DataStore).

When a RelationalTable is created for the DeployedDatabaseSchema, the service automatically inserts the AssetSchemaType relationship, RelationalDBSchemaType entity and AttributeForSchema relationship in between the DeployedAPI entity and the RelationalTable entity.

The SchemaType for a RelationalTable is RelationalTableType. The schema attributes for RelationalTable and RelationalColumn also use the TypeEmbeddedAttribute classification method for defining the schema type.

This integration service is paired with the Data Manager OMAS.

Raise an issue or comment below