Package org.odpi.openmetadata.accessservices.datamanager.api

Interface DatabaseManagerInterface

public interface DatabaseManagerInterface

DatabaseManagerInterface defines the client side interface for the Data Manager OMAS that is relevant for relational database assets. It provides the ability to define and maintain the metadata about a database and the schemas (tables and columns) it contains.

Method Summary

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

Method Detail

createDatabase

String createDatabase(String userId,
                      String databaseManagerGUID,
                      String databaseManagerName,
                      DatabaseProperties databaseProperties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Create a new metadata element to represent a database.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

String createDatabaseFromTemplate(String userId,
                                  String databaseManagerGUID,
                                  String databaseManagerName,
                                  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:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void updateDatabase(String userId,
                    String databaseManagerGUID,
                    String databaseManagerName,
                    String databaseGUID,
                    DatabaseProperties databaseProperties)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException

Update the metadata element representing a database.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void publishDatabase(String userId,
                     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:

userId - calling user

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

void withdrawDatabase(String userId,
                      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:

userId - calling user

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

void removeDatabase(String userId,
                    String databaseManagerGUID,
                    String databaseManagerName,
                    String databaseGUID,
                    String qualifiedName)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException

Remove the metadata element representing a database.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

List<DatabaseElement> findDatabases(String userId,
                                    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:

userId - calling user

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

List<DatabaseElement> getDatabasesByName(String userId,
                                         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:

userId - calling user

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)

getDatabasesForDatabaseManager

List<DatabaseElement> getDatabasesForDatabaseManager(String userId,
                                                     String databaseManagerGUID,
                                                     String databaseManagerName,
                                                     int startFrom,
                                                     int pageSize)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Retrieve the list of databases created by this caller.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the database manager (DBMS)

databaseManagerName - unique name of software server capability representing the database manager (DBMS)

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

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

Retrieve the database metadata element with the supplied unique identifier.

Parameters:

userId - calling user

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

String createDatabaseSchema(String userId,
                            String databaseManagerGUID,
                            String databaseManagerName,
                            String databaseGUID,
                            DatabaseSchemaProperties databaseSchemaProperties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Create a new metadata element to represent a database schema.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

String createDatabaseSchemaFromTemplate(String userId,
                                        String databaseManagerGUID,
                                        String databaseManagerName,
                                        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:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void updateDatabaseSchema(String userId,
                          String databaseManagerGUID,
                          String databaseManagerName,
                          String databaseSchemaGUID,
                          DatabaseSchemaProperties databaseSchemaProperties)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Update the metadata element representing a database schema.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void publishDatabaseSchema(String userId,
                           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:

userId - calling user

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

void withdrawDatabaseSchema(String userId,
                            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:

userId - calling user

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

void removeDatabaseSchema(String userId,
                          String databaseManagerGUID,
                          String databaseManagerName,
                          String databaseSchemaGUID,
                          String qualifiedName)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Remove the metadata element representing a database schema.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

List<DatabaseSchemaElement> findDatabaseSchemas(String userId,
                                                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:

userId - calling user

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

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

Return the list of schemas associated with a database.

Parameters:

userId - calling user

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

List<DatabaseSchemaElement> getDatabaseSchemasByName(String userId,
                                                     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:

userId - calling user

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

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

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

Parameters:

userId - calling user

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

String createDatabaseTable(String userId,
                           String databaseManagerGUID,
                           String databaseManagerName,
                           String databaseSchemaGUID,
                           DatabaseTableProperties databaseTableProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Create a new metadata element to represent a database table.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

String createDatabaseTableFromTemplate(String userId,
                                       String databaseManagerGUID,
                                       String databaseManagerName,
                                       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:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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 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)

updateDatabaseTable

void updateDatabaseTable(String userId,
                         String databaseManagerGUID,
                         String databaseManagerName,
                         String databaseTableGUID,
                         DatabaseTableProperties databaseTableProperties)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Update the metadata element representing a database table.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void removeDatabaseTable(String userId,
                         String databaseManagerGUID,
                         String databaseManagerName,
                         String databaseTableGUID,
                         String qualifiedName)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Remove the metadata element representing a database table.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

List<DatabaseTableElement> findDatabaseTables(String userId,
                                              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:

userId - calling user

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

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

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

Parameters:

userId - calling user

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

List<DatabaseTableElement> getDatabaseTablesByName(String userId,
                                                   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:

userId - calling user

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

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

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

Parameters:

userId - calling user

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

String createDatabaseView(String userId,
                          String databaseManagerGUID,
                          String databaseManagerName,
                          String databaseSchemaGUID,
                          DatabaseViewProperties databaseViewProperties)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Create a new metadata element to represent a database view.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

String createDatabaseViewFromTemplate(String userId,
                                      String databaseManagerGUID,
                                      String databaseManagerName,
                                      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:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void updateDatabaseView(String userId,
                        String databaseManagerGUID,
                        String databaseManagerName,
                        String databaseViewGUID,
                        DatabaseViewProperties databaseViewProperties)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Update the metadata element representing a database table.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void removeDatabaseView(String userId,
                        String databaseManagerGUID,
                        String databaseManagerName,
                        String databaseViewGUID,
                        String qualifiedName)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Remove the metadata element representing a database table.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

List<DatabaseViewElement> findDatabaseViews(String userId,
                                            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:

userId - calling user

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

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

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

Parameters:

userId - calling user

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

List<DatabaseViewElement> getDatabaseViewsByName(String userId,
                                                 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:

userId - calling user

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

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

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

Parameters:

userId - calling user

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

String createDatabaseColumn(String userId,
                            String databaseManagerGUID,
                            String databaseManagerName,
                            String databaseTableGUID,
                            DatabaseColumnProperties databaseColumnProperties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Create a new metadata element to represent a database column.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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 new 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

String createDatabaseColumnFromTemplate(String userId,
                                        String databaseManagerGUID,
                                        String databaseManagerName,
                                        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:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void updateDatabaseColumn(String userId,
                          String databaseManagerGUID,
                          String databaseManagerName,
                          String databaseColumnGUID,
                          DatabaseColumnProperties databaseColumnProperties)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Update the metadata element representing a database column.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void removeDatabaseColumn(String userId,
                          String databaseManagerGUID,
                          String databaseManagerName,
                          String databaseColumnGUID,
                          String qualifiedName)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Remove the metadata element representing a database column.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

List<DatabaseColumnElement> findDatabaseColumns(String userId,
                                                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:

userId - calling user

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

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

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

Parameters:

userId - calling user

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

List<DatabaseColumnElement> getDatabaseColumnsByName(String userId,
                                                     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:

userId - calling user

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

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

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

Parameters:

userId - calling user

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

void setPrimaryKeyOnColumn(String userId,
                           String databaseManagerGUID,
                           String databaseManagerName,
                           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:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void removePrimaryKeyFromColumn(String userId,
                                String databaseManagerGUID,
                                String databaseManagerName,
                                String databaseColumnGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the classification that this column is a primary key.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void addForeignKeyRelationship(String userId,
                               String databaseManagerGUID,
                               String databaseManagerName,
                               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:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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

void removeForeignKeyRelationship(String userId,
                                  String databaseManagerGUID,
                                  String databaseManagerName,
                                  String primaryKeyColumnGUID,
                                  String foreignKeyColumnGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Remove the foreign key relationship for the requested columns.

Parameters:

userId - calling user

databaseManagerGUID - unique identifier of software server capability representing the caller

databaseManagerName - unique name of software server capability representing the caller

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)