org.odpi.openmetadata.integrationservices.database.connector

Class DatabaseIntegratorContext

java.lang.Object

org.odpi.openmetadata.integrationservices.database.connector.DatabaseIntegratorContext

public class DatabaseIntegratorContext
extends Object

DatabaseIntegratorContext is the context for managing resources from a relational database server.

Constructor Summary

Constructors

Constructor and Description
DatabaseIntegratorContext(DatabaseManagerClient client, DataManagerEventClient eventClient, String userId, String databaseManagerGUID, String databaseManagerName) Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method and Description
void	addForeignKeyRelationship(String primaryKeyColumnGUID, String foreignKeyColumnGUID, DatabaseForeignKeyProperties databaseForeignKeyProperties) Create a foreign relationship between two columns.
String	createDatabase(DatabaseProperties databaseProperties) Create a new metadata element to represent a database.
String	createDatabaseColumn(String databaseTableGUID, DatabaseColumnProperties databaseColumnProperties) Create a new metadata element to represent a database column.
String	createDatabaseColumnFromTemplate(String templateGUID, String databaseTableGUID, TemplateProperties templateProperties) Create a new metadata element to represent a database column using an existing metadata element as a template.
String	createDatabaseFromTemplate(String templateGUID, TemplateProperties templateProperties) Create a new metadata element to represent a database using an existing metadata element as a template.
String	createDatabaseSchema(String databaseGUID, DatabaseSchemaProperties databaseSchemaProperties) Create a new metadata element to represent a database schema.
String	createDatabaseSchemaFromTemplate(String templateGUID, String databaseGUID, TemplateProperties templateProperties) Create a new metadata element to represent a database schema using an existing metadata element as a template.
String	createDatabaseTable(String databaseSchemaGUID, DatabaseTableProperties databaseTableProperties) Create a new metadata element to represent a database table.
String	createDatabaseTableFromTemplate(String templateGUID, String databaseSchemaGUID, TemplateProperties templateProperties) Create a new metadata element to represent a database table using an existing metadata element as a template.
String	createDatabaseView(String databaseSchemaGUID, DatabaseViewProperties databaseViewProperties) Create a new metadata element to represent a database view.
String	createDatabaseViewFromTemplate(String templateGUID, String databaseSchemaGUID, TemplateProperties templateProperties) Create a new metadata element to represent a database view using an existing metadata element as a template.
List<DatabaseColumnElement>	findDatabaseColumns(String searchString, int startFrom, int pageSize) Retrieve the list of database column metadata elements that contain the search string.
List<DatabaseElement>	findDatabases(String searchString, int startFrom, int pageSize) Retrieve the list of database metadata elements that contain the search string.
List<DatabaseSchemaElement>	findDatabaseSchemas(String searchString, int startFrom, int pageSize) Retrieve the list of database schema metadata elements that contain the search string.
List<DatabaseTableElement>	findDatabaseTables(String searchString, int startFrom, int pageSize) Retrieve the list of database table metadata elements that contain the search string.
List<DatabaseViewElement>	findDatabaseViews(String searchString, int startFrom, int pageSize) Retrieve the list of database view metadata elements that contain the search string.
List<DatabaseColumnElement>	getColumnsForDatabaseTable(String databaseTableGUID, int startFrom, int pageSize) Retrieve the list of column for a database table (or view)
DatabaseElement	getDatabaseByGUID(String guid) Retrieve the database metadata element with the supplied unique identifier.
DatabaseColumnElement	getDatabaseColumnByGUID(String guid) Retrieve the database column metadata element with the supplied unique identifier.
List<DatabaseColumnElement>	getDatabaseColumnsByName(String name, int startFrom, int pageSize) Retrieve the list of database column metadata elements with a matching qualified or display name.
List<DatabaseElement>	getDatabasesByName(String name, int startFrom, int pageSize) Retrieve the list of database metadata elements with a matching qualified or display name.
DatabaseSchemaElement	getDatabaseSchemaByGUID(String guid) Retrieve the database schema metadata element with the supplied unique identifier.
List<DatabaseSchemaElement>	getDatabaseSchemasByName(String name, int startFrom, int pageSize) Retrieve the list of database schema metadata elements with a matching qualified or display name.
DatabaseTableElement	getDatabaseTableByGUID(String guid) Retrieve the database table metadata element with the supplied unique identifier.
List<DatabaseTableElement>	getDatabaseTablesByName(String name, int startFrom, int pageSize) Retrieve the list of database table metadata elements with a matching qualified or display name.
DatabaseViewElement	getDatabaseViewByGUID(String guid) Retrieve the database view metadata element with the supplied unique identifier.
List<DatabaseViewElement>	getDatabaseViewsByName(String name, int startFrom, int pageSize) Retrieve the list of database view metadata elements with a matching qualified or display name.
List<DatabaseElement>	getMyDatabases(int startFrom, int pageSize) Retrieve the list of databases created by this caller.
List<DatabaseSchemaElement>	getSchemasForDatabase(String databaseGUID, int startFrom, int pageSize) Return the list of schemas associated with a database.
List<DatabaseTableElement>	getTablesForDatabaseSchema(String databaseSchemaGUID, int startFrom, int pageSize) Retrieve the list of database tables associated with a database schema.
List<DatabaseViewElement>	getViewsForDatabaseSchema(String databaseSchemaGUID, int startFrom, int pageSize) Retrieve the list of database views associated with a database schema.
void	publishDatabase(String databaseGUID) Update the zones for the database asset so that it becomes visible to consumers.
void	publishDatabaseSchema(String databaseSchemaGUID) Update the zones for the database asset so that it becomes visible to consumers.
void	registerListener(DataManagerEventListener listener) Register a listener object that will be passed each of the events published by the Data Manager OMAS.
void	removeDatabase(String databaseGUID, String qualifiedName) Remove the metadata element representing a database.
void	removeDatabaseColumn(String databaseColumnGUID, String qualifiedName) Remove the metadata element representing a database column.
void	removeDatabaseSchema(String databaseSchemaGUID, String qualifiedName) Remove the metadata element representing a database schema.
void	removeDatabaseTable(String databaseTableGUID, String qualifiedName) Remove the metadata element representing a database table.
void	removeDatabaseView(String databaseViewGUID, String qualifiedName) Remove the metadata element representing a database table.
void	removeForeignKeyRelationship(String primaryKeyColumnGUID, String foreignKeyColumnGUID) Remove the foreign key relationship for the requested columns.
void	removePrimaryKeyFromColumn(String databaseColumnGUID) Remove the classification that this column is a primary key.
void	setPrimaryKeyOnColumn(String databaseColumnGUID, DatabasePrimaryKeyProperties databasePrimaryKeyProperties) Classify a column in a database table as the primary key.
void	updateDatabase(String databaseGUID, DatabaseProperties databaseProperties) Update the metadata element representing a database.
void	updateDatabaseColumn(String databaseColumnGUID, DatabaseColumnProperties databaseColumnProperties) Update the metadata element representing a database column.
void	updateDatabaseSchema(String databaseSchemaGUID, DatabaseSchemaProperties databaseSchemaProperties) Update the metadata element representing a database schema.
void	updateDatabaseTable(String databaseTableGUID, DatabaseTableProperties databaseTableProperties) Update the metadata element representing a database table.
void	updateDatabaseView(String databaseViewGUID, DatabaseViewProperties databaseViewProperties) Update the metadata element representing a database table.
void	withdrawDatabase(String databaseGUID) Update the zones for the database asset so that it is no longer visible to consumers.
void	withdrawDatabaseSchema(String databaseSchemaGUID) Update the zones for the database asset so that it is no longer visible to consumers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatabaseIntegratorContext

public DatabaseIntegratorContext(DatabaseManagerClient client,
                                 DataManagerEventClient eventClient,
                                 String userId,
                                 String databaseManagerGUID,
                                 String databaseManagerName)

Create a new client with no authentication embedded in the HTTP request.

Parameters:

client - client to map request to

eventClient - client to register for events

userId - integration daemon's userId

databaseManagerGUID - unique identifier of the software server capability for the database manager

databaseManagerName - unique name of the software server capability for the database manager

Method Detail

registerListener

public void registerListener(DataManagerEventListener listener)
                      throws InvalidParameterException,
                             ConnectionCheckedException,
                             ConnectorCheckedException,
                             PropertyServerException,
                             UserNotAuthorizedException

Register a listener object that will be passed each of the events published by the Data Manager OMAS.

Parameters:

listener - listener object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createDatabase

public String createDatabase(DatabaseProperties databaseProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Create a new metadata element to represent a database.

Parameters:

databaseProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDatabaseFromTemplate

public String createDatabaseFromTemplate(String templateGUID,
                                         TemplateProperties templateProperties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Create a new metadata element to represent a database using an existing metadata element as a template.

Parameters:

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateDatabase

public void updateDatabase(String databaseGUID,
                           DatabaseProperties databaseProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Update the metadata element representing a database.

Parameters:

databaseGUID - unique identifier of the metadata element to update

databaseProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishDatabase

public void publishDatabase(String databaseGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Update the zones for the database asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).

Parameters:

databaseGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawDatabase

public void withdrawDatabase(String databaseGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Update the zones for the database asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the database is first created).

Parameters:

databaseGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeDatabase

public void removeDatabase(String databaseGUID,
                           String qualifiedName)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Remove the metadata element representing a database.

Parameters:

databaseGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findDatabases

public List<DatabaseElement> findDatabases(String searchString,
                                           int startFrom,
                                           int pageSize)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Retrieve the list of database metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDatabasesByName

public List<DatabaseElement> getDatabasesByName(String name,
                                                int startFrom,
                                                int pageSize)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Retrieve the list of database metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getMyDatabases

public List<DatabaseElement> getMyDatabases(int startFrom,
                                            int pageSize)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Retrieve the list of databases created by this caller.

Parameters:

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDatabaseByGUID

public DatabaseElement getDatabaseByGUID(String guid)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Retrieve the database metadata element with the supplied unique identifier.

Parameters:

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDatabaseSchema

public String createDatabaseSchema(String databaseGUID,
                                   DatabaseSchemaProperties databaseSchemaProperties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Create a new metadata element to represent a database schema.

Parameters:

databaseGUID - unique identifier of the database where the schema is located

databaseSchemaProperties - properties about the database schema

Returns:

unique identifier of the new database schema

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDatabaseSchemaFromTemplate

public String createDatabaseSchemaFromTemplate(String templateGUID,
                                               String databaseGUID,
                                               TemplateProperties templateProperties)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Create a new metadata element to represent a database schema using an existing metadata element as a template.

Parameters:

templateGUID - unique identifier of the metadata element to copy

databaseGUID - unique identifier of the database where the schema is located

templateProperties - properties that override the template

Returns:

unique identifier of the new database schema

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateDatabaseSchema

public void updateDatabaseSchema(String databaseSchemaGUID,
                                 DatabaseSchemaProperties databaseSchemaProperties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Update the metadata element representing a database schema.

Parameters:

databaseSchemaGUID - unique identifier of the metadata element to update

databaseSchemaProperties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishDatabaseSchema

public void publishDatabaseSchema(String databaseSchemaGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Update the zones for the database asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).

Parameters:

databaseSchemaGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawDatabaseSchema

public void withdrawDatabaseSchema(String databaseSchemaGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Update the zones for the database asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the database is first created).

Parameters:

databaseSchemaGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeDatabaseSchema

public void removeDatabaseSchema(String databaseSchemaGUID,
                                 String qualifiedName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Remove the metadata element representing a database schema.

Parameters:

databaseSchemaGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findDatabaseSchemas

public List<DatabaseSchemaElement> findDatabaseSchemas(String searchString,
                                                       int startFrom,
                                                       int pageSize)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Retrieve the list of database schema metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSchemasForDatabase

public List<DatabaseSchemaElement> getSchemasForDatabase(String databaseGUID,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Return the list of schemas associated with a database.

Parameters:

databaseGUID - unique identifier of the database to query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of metadata elements describing the schemas associated with the requested database

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDatabaseSchemasByName

public List<DatabaseSchemaElement> getDatabaseSchemasByName(String name,
                                                            int startFrom,
                                                            int pageSize)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Retrieve the list of database schema metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDatabaseSchemaByGUID

public DatabaseSchemaElement getDatabaseSchemaByGUID(String guid)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Retrieve the database schema metadata element with the supplied unique identifier.

Parameters:

guid - unique identifier of the requested metadata element

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDatabaseTable

public String createDatabaseTable(String databaseSchemaGUID,
                                  DatabaseTableProperties databaseTableProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Create a new metadata element to represent a database table.

Parameters:

databaseSchemaGUID - unique identifier of the database schema where the database table is located.

databaseTableProperties - properties for the database table

Returns:

unique identifier of the new metadata element for the database table

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDatabaseTableFromTemplate

public String createDatabaseTableFromTemplate(String templateGUID,
                                              String databaseSchemaGUID,
                                              TemplateProperties templateProperties)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Create a new metadata element to represent a database table using an existing metadata element as a template.

Parameters:

templateGUID - unique identifier of the metadata element to copy

databaseSchemaGUID - unique identifier of the database schema where the database table is located.

templateProperties - properties that override the template

Returns:

unique identifier of the new database table

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateDatabaseTable

public void updateDatabaseTable(String databaseTableGUID,
                                DatabaseTableProperties databaseTableProperties)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Update the metadata element representing a database table.

Parameters:

databaseTableGUID - unique identifier of the database table to update

databaseTableProperties - new properties for the database table

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeDatabaseTable

public void removeDatabaseTable(String databaseTableGUID,
                                String qualifiedName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the metadata element representing a database table.

Parameters:

databaseTableGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findDatabaseTables

public List<DatabaseTableElement> findDatabaseTables(String searchString,
                                                     int startFrom,
                                                     int pageSize)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Retrieve the list of database table metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getTablesForDatabaseSchema

public List<DatabaseTableElement> getTablesForDatabaseSchema(String databaseSchemaGUID,
                                                             int startFrom,
                                                             int pageSize)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Retrieve the list of database tables associated with a database schema.

Parameters:

databaseSchemaGUID - unique identifier of the database schema of interest

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of associated metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDatabaseTablesByName

public List<DatabaseTableElement> getDatabaseTablesByName(String name,
                                                          int startFrom,
                                                          int pageSize)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Retrieve the list of database table metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDatabaseTableByGUID

public DatabaseTableElement getDatabaseTableByGUID(String guid)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve the database table metadata element with the supplied unique identifier.

Parameters:

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDatabaseView

public String createDatabaseView(String databaseSchemaGUID,
                                 DatabaseViewProperties databaseViewProperties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Create a new metadata element to represent a database view.

Parameters:

databaseSchemaGUID - unique identifier of the database schema where the database view is located.

databaseViewProperties - properties for the new view

Returns:

unique identifier of the new metadata element for the database view

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDatabaseViewFromTemplate

public String createDatabaseViewFromTemplate(String templateGUID,
                                             String databaseSchemaGUID,
                                             TemplateProperties templateProperties)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Create a new metadata element to represent a database view using an existing metadata element as a template.

Parameters:

templateGUID - unique identifier of the metadata element to copy

databaseSchemaGUID - unique identifier of the database schema where the database view is located.

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element for the database view

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateDatabaseView

public void updateDatabaseView(String databaseViewGUID,
                               DatabaseViewProperties databaseViewProperties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Update the metadata element representing a database table.

Parameters:

databaseViewGUID - unique identifier of the database view to update

databaseViewProperties - properties for the new database view

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeDatabaseView

public void removeDatabaseView(String databaseViewGUID,
                               String qualifiedName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Remove the metadata element representing a database table.

Parameters:

databaseViewGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findDatabaseViews

public List<DatabaseViewElement> findDatabaseViews(String searchString,
                                                   int startFrom,
                                                   int pageSize)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve the list of database view metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getViewsForDatabaseSchema

public List<DatabaseViewElement> getViewsForDatabaseSchema(String databaseSchemaGUID,
                                                           int startFrom,
                                                           int pageSize)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Retrieve the list of database views associated with a database schema.

Parameters:

databaseSchemaGUID - unique identifier of the database schema of interest

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of associated metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDatabaseViewsByName

public List<DatabaseViewElement> getDatabaseViewsByName(String name,
                                                        int startFrom,
                                                        int pageSize)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Retrieve the list of database view metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDatabaseViewByGUID

public DatabaseViewElement getDatabaseViewByGUID(String guid)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Retrieve the database view metadata element with the supplied unique identifier.

Parameters:

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDatabaseColumn

public String createDatabaseColumn(String databaseTableGUID,
                                   DatabaseColumnProperties databaseColumnProperties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Create a new metadata element to represent a database column.

Parameters:

databaseTableGUID - unique identifier of the database table where this column is located

databaseColumnProperties - properties for the new column

Returns:

unique identifier of the new metadata element for the database column

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDatabaseColumnFromTemplate

public String createDatabaseColumnFromTemplate(String templateGUID,
                                               String databaseTableGUID,
                                               TemplateProperties templateProperties)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Create a new metadata element to represent a database column using an existing metadata element as a template.

Parameters:

templateGUID - unique identifier of the metadata element to copy

databaseTableGUID - unique identifier of the database table where this column is located

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element for the database column

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateDatabaseColumn

public void updateDatabaseColumn(String databaseColumnGUID,
                                 DatabaseColumnProperties databaseColumnProperties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Update the metadata element representing a database column.

Parameters:

databaseColumnGUID - unique identifier of the metadata element to update

databaseColumnProperties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeDatabaseColumn

public void removeDatabaseColumn(String databaseColumnGUID,
                                 String qualifiedName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Remove the metadata element representing a database column.

Parameters:

databaseColumnGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findDatabaseColumns

public List<DatabaseColumnElement> findDatabaseColumns(String searchString,
                                                       int startFrom,
                                                       int pageSize)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Retrieve the list of database column metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getColumnsForDatabaseTable

public List<DatabaseColumnElement> getColumnsForDatabaseTable(String databaseTableGUID,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Retrieve the list of column for a database table (or view)

Parameters:

databaseTableGUID - unique identifier of the database table of interest

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDatabaseColumnsByName

public List<DatabaseColumnElement> getDatabaseColumnsByName(String name,
                                                            int startFrom,
                                                            int pageSize)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Retrieve the list of database column metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDatabaseColumnByGUID

public DatabaseColumnElement getDatabaseColumnByGUID(String guid)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Retrieve the database column metadata element with the supplied unique identifier.

Parameters:

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setPrimaryKeyOnColumn

public void setPrimaryKeyOnColumn(String databaseColumnGUID,
                                  DatabasePrimaryKeyProperties databasePrimaryKeyProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Classify a column in a database table as the primary key. This means each row has a different value in this column and it can be used to uniquely identify the column.

Parameters:

databaseColumnGUID - unique identifier if the primary key column

databasePrimaryKeyProperties - properties to store

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removePrimaryKeyFromColumn

public void removePrimaryKeyFromColumn(String databaseColumnGUID)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Remove the classification that this column is a primary key.

Parameters:

databaseColumnGUID - unique identifier if the primary key column

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

addForeignKeyRelationship

public void addForeignKeyRelationship(String primaryKeyColumnGUID,
                                      String foreignKeyColumnGUID,
                                      DatabaseForeignKeyProperties databaseForeignKeyProperties)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Create a foreign relationship between two columns. One of the columns holds the primary key of the other to form a link.

Parameters:

primaryKeyColumnGUID - unique identifier of the column containing the primary key

foreignKeyColumnGUID - unique identifier of the column containing the primary key from the other table

databaseForeignKeyProperties - properties about the foreign key relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeForeignKeyRelationship

public void removeForeignKeyRelationship(String primaryKeyColumnGUID,
                                         String foreignKeyColumnGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Remove the foreign key relationship for the requested columns.

Parameters:

primaryKeyColumnGUID - unique identifier of the column that is the linked primary key

foreignKeyColumnGUID - unique identifier of the column the contains the primary key from another table

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)