Package org.odpi.openmetadata.accessservices.datamanager.client

Class DatabaseManagerClient

java.lang.Object
org.odpi.openmetadata.accessservices.datamanager.client.DataManagerBaseClient
org.odpi.openmetadata.accessservices.datamanager.client.DatabaseManagerClient
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
public class DatabaseManagerClient extends DataManagerBaseClient implements org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
DatabaseManagerClient is the client for managing resources from a relational database server.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DatabaseManagerClient(String serverName, String serverPlatformURLRoot)
    Create a new client with no authentication embedded in the HTTP request.
    DatabaseManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password)
    Create a new client that passes userId and password in each HTTP request.
    DatabaseManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that passes userId and password in each HTTP request.
    DatabaseManagerClient(String serverName, String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize)
    Create a new client that is going to be used in an OMAG Server.
    DatabaseManagerClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client with no authentication embedded in the HTTP request.

  • Method Summary

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

    Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.client.DataManagerBaseClient

    removeReferenceable

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DatabaseManagerClient

      public DatabaseManagerClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • DatabaseManagerClient

      public DatabaseManagerClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • DatabaseManagerClient

      public DatabaseManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • DatabaseManagerClient

      public DatabaseManagerClient(String serverName, String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that is going to be used in an OMAG Server.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      restClient - client that issues the REST API calls
      maxPageSize - maximum number of results supported by this server
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • DatabaseManagerClient

      public DatabaseManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

  • Method Details

    • createDatabase

      public String createDatabase(String userId, String databaseManagerGUID, String databaseManagerName, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseProperties databaseProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database.
      Specified by:
      createDatabase in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseProperties - properties to store
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDatabaseFromTemplate

      public String createDatabaseFromTemplate(String userId, String databaseManagerGUID, String databaseManagerName, String templateGUID, org.odpi.openmetadata.accessservices.datamanager.properties.TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database using an existing metadata element as a template.
      Specified by:
      createDatabaseFromTemplate in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateDatabase

      public void updateDatabase(String userId, String databaseManagerGUID, String databaseManagerName, String databaseGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseProperties databaseProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a database.
      Specified by:
      updateDatabase in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      databaseProperties - new properties for this element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • publishDatabase

      public void publishDatabase(String userId, String databaseGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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).
      Specified by:
      publishDatabase in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseGUID - unique identifier of the metadata element to publish
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • withdrawDatabase

      public void withdrawDatabase(String userId, String databaseGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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).
      Specified by:
      withdrawDatabase in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseGUID - unique identifier of the metadata element to withdraw
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeDatabase

      public void removeDatabase(String userId, String databaseManagerGUID, String databaseManagerName, String databaseGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a database.
      Specified by:
      removeDatabase in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseGUID - unique identifier of the metadata element to remove
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findDatabases

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseElement> findDatabases(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findDatabases in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDatabasesByName

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseElement> getDatabasesByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getDatabasesByName in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDatabasesForDatabaseManager

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseElement> getDatabasesForDatabaseManager(String userId, String databaseManagerGUID, String databaseManagerName, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of databases created by this caller.
      Specified by:
      getDatabasesForDatabaseManager in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDatabaseByGUID

      public org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseElement getDatabaseByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the database metadata element with the supplied unique identifier.
      Specified by:
      getDatabaseByGUID in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDatabaseSchema

      public String createDatabaseSchema(String userId, String databaseManagerGUID, String databaseManagerName, String databaseGUID, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseSchemaProperties databaseSchemaProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database schema.
      Specified by:
      createDatabaseSchema in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDatabaseSchemaFromTemplate

      public String createDatabaseSchemaFromTemplate(String userId, String databaseManagerGUID, String databaseManagerName, String templateGUID, String databaseGUID, org.odpi.openmetadata.accessservices.datamanager.properties.TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database schema using an existing metadata element as a template.
      Specified by:
      createDatabaseSchemaFromTemplate in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateDatabaseSchema

      public void updateDatabaseSchema(String userId, String databaseManagerGUID, String databaseManagerName, String databaseSchemaGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseSchemaProperties databaseSchemaProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a database schema.
      Specified by:
      updateDatabaseSchema in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseSchemaGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      databaseSchemaProperties - new properties for the metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • publishDatabaseSchema

      public void publishDatabaseSchema(String userId, String databaseSchemaGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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).
      Specified by:
      publishDatabaseSchema in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseSchemaGUID - unique identifier of the metadata element to publish
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • withdrawDatabaseSchema

      public void withdrawDatabaseSchema(String userId, String databaseSchemaGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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).
      Specified by:
      withdrawDatabaseSchema in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseSchemaGUID - unique identifier of the metadata element to withdraw
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeDatabaseSchema

      public void removeDatabaseSchema(String userId, String databaseManagerGUID, String databaseManagerName, String databaseSchemaGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a database schema.
      Specified by:
      removeDatabaseSchema in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseSchemaGUID - unique identifier of the metadata element to remove
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findDatabaseSchemas

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseSchemaElement> findDatabaseSchemas(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database schema metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findDatabaseSchemas in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getSchemasForDatabase

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseSchemaElement> getSchemasForDatabase(String userId, String databaseGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the list of schemas associated with a database.
      Specified by:
      getSchemasForDatabase in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDatabaseSchemasByName

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseSchemaElement> getDatabaseSchemasByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database schema metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getDatabaseSchemasByName in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDatabaseSchemaByGUID

      public org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseSchemaElement getDatabaseSchemaByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the database schema metadata element with the supplied unique identifier.
      Specified by:
      getDatabaseSchemaByGUID in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      requested metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDatabaseSchemaType

      public String createDatabaseSchemaType(String userId, String databaseManagerGUID, String databaseManagerName, String qualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a database top-level schema type used to attach tables and views to the database/database schema.
      Specified by:
      createDatabaseSchemaType in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - guid of the software server capability entity that represented the external source - null for local
      databaseManagerName - name of the software server capability entity that represented the external source - null for local
      qualifiedName - qualified name ofr the schema type - suggest "SchemaOf:" + asset's qualified name
      Returns:
      unique identifier of the database schema type
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • attachSchemaTypeToDatabaseAsset

      public void attachSchemaTypeToDatabaseAsset(String userId, String databaseManagerGUID, String databaseManagerName, String databaseAssetGUID, String schemaTypeGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Link the schema type and asset. This is called from outside AssetHandler. The databaseAssetGUID is checked to ensure the asset exists and updates are allowed. If there is already a schema attached, it is deleted.
      Specified by:
      attachSchemaTypeToDatabaseAsset in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - guid of the software server capability entity that represented the external source - null for local
      databaseManagerName - name of the software server capability entity that represented the external source - null for local
      databaseAssetGUID - unique identifier of the asset to connect the schema to
      schemaTypeGUID - identifier for schema Type object
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • createDatabaseTable

      public String createDatabaseTable(String userId, String databaseManagerGUID, String databaseManagerName, String databaseAssetGUID, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseTableProperties databaseTableProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database table.
      Specified by:
      createDatabaseTable in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseAssetGUID - unique identifier of the database or 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDatabaseTableFromTemplate

      public String createDatabaseTableFromTemplate(String userId, String databaseManagerGUID, String databaseManagerName, String templateGUID, String databaseAssetGUID, org.odpi.openmetadata.accessservices.datamanager.properties.TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database table using an existing metadata element as a template.
      Specified by:
      createDatabaseTableFromTemplate in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      templateGUID - unique identifier of the metadata element to copy
      databaseAssetGUID - unique identifier of the database or database schema where the database table is located.
      templateProperties - properties that override the template
      Returns:
      unique identifier of the new database table
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDatabaseTableForSchemaType

      public String createDatabaseTableForSchemaType(String userId, String databaseManagerGUID, String databaseManagerName, String databaseSchemaTypeGUID, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseTableProperties databaseTableProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database table.
      Specified by:
      createDatabaseTableForSchemaType in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseSchemaTypeGUID - unique identifier of the database or 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateDatabaseTable

      public void updateDatabaseTable(String userId, String databaseManagerGUID, String databaseManagerName, String databaseTableGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseTableProperties databaseTableProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a database table.
      Specified by:
      updateDatabaseTable in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseTableGUID - unique identifier of the database table to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      databaseTableProperties - new properties for the database table
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeDatabaseTable

      public void removeDatabaseTable(String userId, String databaseManagerGUID, String databaseManagerName, String databaseTableGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a database table.
      Specified by:
      removeDatabaseTable in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseTableGUID - unique identifier of the metadata element to remove
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findDatabaseTables

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseTableElement> findDatabaseTables(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database table metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findDatabaseTables in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getTablesForDatabaseSchema

      @Deprecated public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseTableElement> getTablesForDatabaseSchema(String userId, String databaseSchemaGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Deprecated.
      Retrieve the list of database tables associated with a database schema.
      Specified by:
      getTablesForDatabaseSchema in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getTablesForDatabaseAsset

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseTableElement> getTablesForDatabaseAsset(String userId, String databaseAssetGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database tables associated with a database or database schema.
      Specified by:
      getTablesForDatabaseAsset in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseAssetGUID - unique identifier of the database or database schema of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of associated metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDatabaseTablesByName

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseTableElement> getDatabaseTablesByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database table metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getDatabaseTablesByName in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDatabaseTableByGUID

      public org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseTableElement getDatabaseTableByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the database table metadata element with the supplied unique identifier.
      Specified by:
      getDatabaseTableByGUID in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDatabaseView

      public String createDatabaseView(String userId, String databaseManagerGUID, String databaseManagerName, String databaseAssetGUID, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseViewProperties databaseViewProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database view.
      Specified by:
      createDatabaseView in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseAssetGUID - unique identifier of the database or 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDatabaseViewFromTemplate

      public String createDatabaseViewFromTemplate(String userId, String databaseManagerGUID, String databaseManagerName, String templateGUID, String databaseAssetGUID, org.odpi.openmetadata.accessservices.datamanager.properties.TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database view using an existing metadata element as a template.
      Specified by:
      createDatabaseViewFromTemplate in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      templateGUID - unique identifier of the metadata element to copy
      databaseAssetGUID - unique identifier of the database or 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDatabaseViewForSchemaType

      public String createDatabaseViewForSchemaType(String userId, String databaseManagerGUID, String databaseManagerName, String databaseSchemaTypeGUID, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseViewProperties databaseViewProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database view.
      Specified by:
      createDatabaseViewForSchemaType in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseSchemaTypeGUID - unique identifier of the schema type 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateDatabaseView

      public void updateDatabaseView(String userId, String databaseManagerGUID, String databaseManagerName, String databaseViewGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseViewProperties databaseViewProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a database table.
      Specified by:
      updateDatabaseView in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseViewGUID - unique identifier of the database view to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      databaseViewProperties - properties for the new database view
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeDatabaseView

      public void removeDatabaseView(String userId, String databaseManagerGUID, String databaseManagerName, String databaseViewGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a database table.
      Specified by:
      removeDatabaseView in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseViewGUID - unique identifier of the metadata element to remove
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findDatabaseViews

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseViewElement> findDatabaseViews(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database view metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findDatabaseViews in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getViewsForDatabaseSchema

      @Deprecated public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseViewElement> getViewsForDatabaseSchema(String userId, String databaseSchemaGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Deprecated.
      Retrieve the list of database views associated with a database schema.
      Specified by:
      getViewsForDatabaseSchema in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getViewsForDatabaseAsset

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseViewElement> getViewsForDatabaseAsset(String userId, String databaseAssetGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database views associated with a database or database schema.
      Specified by:
      getViewsForDatabaseAsset in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseAssetGUID - unique identifier of the database or database schema of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of associated metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDatabaseViewsByName

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseViewElement> getDatabaseViewsByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database view metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getDatabaseViewsByName in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDatabaseViewByGUID

      public org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseViewElement getDatabaseViewByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the database view metadata element with the supplied unique identifier.
      Specified by:
      getDatabaseViewByGUID in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDatabaseColumn

      public String createDatabaseColumn(String userId, String databaseManagerGUID, String databaseManagerName, String databaseTableGUID, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseColumnProperties databaseColumnProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database column.
      Specified by:
      createDatabaseColumn in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDatabaseColumnFromTemplate

      public String createDatabaseColumnFromTemplate(String userId, String databaseManagerGUID, String databaseManagerName, String templateGUID, String databaseTableGUID, org.odpi.openmetadata.accessservices.datamanager.properties.TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a database column using an existing metadata element as a template.
      Specified by:
      createDatabaseColumnFromTemplate in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateDatabaseColumn

      public void updateDatabaseColumn(String userId, String databaseManagerGUID, String databaseManagerName, String databaseColumnGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseColumnProperties databaseColumnProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a database column.
      Specified by:
      updateDatabaseColumn in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseColumnGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      databaseColumnProperties - new properties for the metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeDatabaseColumn

      public void removeDatabaseColumn(String userId, String databaseManagerGUID, String databaseManagerName, String databaseColumnGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a database column.
      Specified by:
      removeDatabaseColumn in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseColumnGUID - unique identifier of the metadata element to remove
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findDatabaseColumns

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseColumnElement> findDatabaseColumns(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database column metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findDatabaseColumns in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getColumnsForDatabaseTable

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseColumnElement> getColumnsForDatabaseTable(String userId, String databaseTableGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of column for a database table (or view)
      Specified by:
      getColumnsForDatabaseTable in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDatabaseColumnsByName

      public List<org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseColumnElement> getDatabaseColumnsByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of database column metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getDatabaseColumnsByName in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDatabaseColumnByGUID

      public org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseColumnElement getDatabaseColumnByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the database column metadata element with the supplied unique identifier.
      Specified by:
      getDatabaseColumnByGUID in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setPrimaryKeyOnColumn

      public void setPrimaryKeyOnColumn(String userId, String databaseManagerGUID, String databaseManagerName, String databaseColumnGUID, org.odpi.openmetadata.accessservices.datamanager.properties.DatabasePrimaryKeyProperties databasePrimaryKeyProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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.
      Specified by:
      setPrimaryKeyOnColumn in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseColumnGUID - unique identifier if the primary key column
      databasePrimaryKeyProperties - properties to store
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removePrimaryKeyFromColumn

      public void removePrimaryKeyFromColumn(String userId, String databaseManagerGUID, String databaseManagerName, String databaseColumnGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the classification that this column is a primary key.
      Specified by:
      removePrimaryKeyFromColumn in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      databaseColumnGUID - unique identifier if the primary key column
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • addForeignKeyRelationship

      public void addForeignKeyRelationship(String userId, String databaseManagerGUID, String databaseManagerName, String primaryKeyColumnGUID, String foreignKeyColumnGUID, org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseForeignKeyProperties databaseForeignKeyProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a foreign relationship between two columns. One of the columns holds the primary key of the other to form a link.
      Specified by:
      addForeignKeyRelationship in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeForeignKeyRelationship

      public void removeForeignKeyRelationship(String userId, String databaseManagerGUID, String databaseManagerName, String primaryKeyColumnGUID, String foreignKeyColumnGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the foreign key relationship for the requested columns.
      Specified by:
      removeForeignKeyRelationship in interface org.odpi.openmetadata.accessservices.datamanager.api.DatabaseManagerInterface
      Parameters:
      userId - calling user
      databaseManagerGUID - unique identifier of software server capability representing the DBMS
      databaseManagerName - unique name of software server capability representing the DBMS
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)