Skip to content
Technical preview

Technical preview function is in a state that it can be tried. The development is complete, there is documentation and there are samples, tutorials and hands-on labs as appropriate.

The community is looking for feedback on the function before declaring it stable. This feedback may result in changes to the external interfaces.

JDBC Integration Connector

Connector details

The JDBC integration connector connects to a relational database and extracts its database schema information and catalogs it as open metadata.

Figure 1

Figure 1: JDBC integration connector accessing a database and cataloguing its schemas in a metadata access server

It uses an embedded JDBC Digital Resource Connector to access the database.

Catalogued elements

The JDBC integration connector catalogs a database asset, database schema assets, tables, views, columns, primary and foreign keys.

Figure 2

Figure 2: Open metadata types used to catalog a database

If the endpoint information is available, it will also attach the connection information to access the database through the JDBC Digital Resource Connector.

Figure 3

Figure 3: Connection information attached to catalogued database enables consumers of the database to get access to the database contents

Configuration

This connector uses the Database Integrator OMIS running in the Integration Daemon.

This is its connection definition to use on the administration commands that configure the Database Integrator OMIS.

Connection configuration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
    "connection" : 
    {
        "class": "VirtualConnection",
        "connectorType" : 
        {
            "class": "ConnectorType",
            "connectorProviderClassName": "org.odpi.openmetadata.adapters.connectors.integration.jdbc.JdbcIntegrationConnectorProvider"
        },
        "embeddedConnections":
        [
            {
                "class" : "EmbeddedConnection",
                "embeddedConnection" :
                {
                    "class" : "Connection",
                    "userId" : " ... ",
                    "clearPassword" : " ... ",
                    "connectorType" : 
                    {
                        "class": "ConnectorType",
                        "connectorProviderClassName": "org.odpi.openmetadata.adapters.connectors.resource.jdbc.JdbcConnectorProvider"
                    },
                    "endpoint":
                    {
                        "class": "Endpoint",
                        "address" : " ... "
                    }
                }
            }
        ],
        "configurationProperties": 
        {
            "catalog" : " ... ",
            "includeSchemaNames": [],
            "excludeSchemaNames": [],
            "includeTableNames": [],
            "excludeTableNames": [],
            "includeViewNames": [],
            "excludeViewNames": [],
            "includeColumnNames": [],
            "excludeColumnNames": []
        }
    }
}
  • userId: user
  • clearPassword: password
  • address: jdbc format address
  • catalog (optional): null or missing means catalog will not be used during querying, empty string means objects that belong to no catalog will be queried, actual value means objects belonging to specified catalog will be queried
  • include/exclude (optional): lists with database object names to filter out the import, no wildcards supported