Class DatabaseManagerClient

    • Constructor Summary

      Constructors 
      Constructor Description
      DatabaseManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      DatabaseManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      DatabaseManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      DatabaseManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize)
      Create a new client that is going to be used in an OMAG Server.
      DatabaseManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

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