org.odpi.openmetadata.accessservices.dataplatform

Interface RelationalDatabaseInterface

All Known Subinterfaces:

DataPlatformInterface

All Known Implementing Classes:

DataPlatform

public interface RelationalDatabaseInterface

RelationalDatabaseInterface defines the client side interface for the Data Platform OMAS that is relevant for relational database assets. It provides the ability for a relational database server platform to define and maintain the metadata about itself and the relational database assets it hosts. This includes information about databases, database schemas (and the tables, views and columns within them) along with any database functions (aka stored procedures) within them.

Method Summary

Modifier and Type	Method and Description
String	addDatabaseFunction(String userId, String databaseGUID, String functionName)
String	addDatabaseSchema(String userId, String schemaName, List<String> databaseTables, List<String> databaseViews, String deployedDatabaseGUID)
String	addDatabaseServer(String userId, String serverName, String hostName, VendorProperties vendorSpecificProperties, AdditionalProperties databaseServerProperties)
String	addDeployedDatabase(String userId, List<String> connectionsGUID, String databaseName, List<String> databaseSchemas, VendorProperties vendorSpecificProperties, AdditionalProperties databaseServerProperties)
String	addTable(String userId, String tableName)
String	addTable(String userId, String tableName, List<String> columnGUIDs)
List<DatabaseServer>	findDatabaseServersByHost(String userId, String hostName)
DatabaseServer	getDatabaseServerByGUID(String userId, String databaseServerGUID)
DatabaseServer	getDatabaseServerByName(String userId, String databaseServerName)
void	moveDatabaseServer(String userId, String databaseServerGUID, String newHostName)
void	removeDatabaseServer(String userId, String databaseServerGUID)
String	removeDeployedDatabase(String userId, String databaseServerGUID, String databaseGUID)
void	renameDatabaseServer(String userId, String databaseServerGUID, String newSeverName)
void	updateDatabaseServerProperties(String userId, String databaseServerGUID, AdditionalProperties updatedProperties)
void	updateDatabaseServerVendorProperties(String userId, String databaseServerGUID, AdditionalProperties updatedProperties)

Method Detail

addDatabaseServer

String addDatabaseServer(String userId,
                         String serverName,
                         String hostName,
                         VendorProperties vendorSpecificProperties,
                         AdditionalProperties databaseServerProperties)

moveDatabaseServer

void moveDatabaseServer(String userId,
                        String databaseServerGUID,
                        String newHostName)

renameDatabaseServer

void renameDatabaseServer(String userId,
                          String databaseServerGUID,
                          String newSeverName)

getDatabaseServerByGUID

DatabaseServer getDatabaseServerByGUID(String userId,
                                       String databaseServerGUID)

getDatabaseServerByName

DatabaseServer getDatabaseServerByName(String userId,
                                       String databaseServerName)

findDatabaseServersByHost

List<DatabaseServer> findDatabaseServersByHost(String userId,
                                               String hostName)

updateDatabaseServerProperties

void updateDatabaseServerProperties(String userId,
                                    String databaseServerGUID,
                                    AdditionalProperties updatedProperties)

updateDatabaseServerVendorProperties

void updateDatabaseServerVendorProperties(String userId,
                                          String databaseServerGUID,
                                          AdditionalProperties updatedProperties)

removeDatabaseServer

void removeDatabaseServer(String userId,
                          String databaseServerGUID)

addDeployedDatabase

String addDeployedDatabase(String userId,
                           List<String> connectionsGUID,
                           String databaseName,
                           List<String> databaseSchemas,
                           VendorProperties vendorSpecificProperties,
                           AdditionalProperties databaseServerProperties)

removeDeployedDatabase

String removeDeployedDatabase(String userId,
                              String databaseServerGUID,
                              String databaseGUID)

addDatabaseSchema

String addDatabaseSchema(String userId,
                         String schemaName,
                         List<String> databaseTables,
                         List<String> databaseViews,
                         String deployedDatabaseGUID)

addTable

String addTable(String userId,
                String tableName)

addTable

String addTable(String userId,
                String tableName,
                List<String> columnGUIDs)

addDatabaseFunction

String addDatabaseFunction(String userId,
                           String databaseGUID,
                           String functionName)