java.lang.Object

org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

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

public class DatabaseIntegratorContext extends IntegrationContext

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

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
actionControlInterface, connectorName, externalSourceGUID, externalSourceIsHome, externalSourceName, fileClassifier, governanceConfiguration, integrationConnectorGUID, integrationReportWriter, maxPageSize, openIntegrationClient, openMetadataStoreClient, permittedSynchronization, propertyHelper, userId
Constructor Summary

Constructors

Constructor

Description

DatabaseIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, OpenIntegrationClient openIntegrationClient, GovernanceConfiguration governanceConfiguration, OpenMetadataClient openMetadataStoreClient, ActionControlInterface actionControlInterface, DatabaseManagerClient databaseManagerClient, ConnectionManagerClient connectionManagerClient, ValidValueManagement validValueManagement, DataManagerEventClient eventClient, boolean generateIntegrationReport, PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String externalSourceGUID, String externalSourceName, AuditLog auditLog, int maxPageSize)

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

Modifier and Type

Method

Description

void

addForeignKeyRelationship(String primaryKeyColumnGUID, String foreignKeyColumnGUID, DatabaseForeignKeyProperties databaseForeignKeyProperties)

Create a foreign relationship between two columns.

void

attachSchemaTypeToDatabaseAsset(String databaseAssetGUID, String schemaTypeGUID)

Link the schema type and asset.

void

clearAssetConnection(String assetGUID, String connectionGUID)

Remove a relationship between an asset and its connection.

void

clearConnectorType(String connectionGUID, String connectorTypeGUID)

Remove a relationship between a connection and a connector type.

void

clearEmbeddedConnection(String connectionGUID, String embeddedConnectionGUID)

Remove a relationship between a virtual connection and an embedded connection.

void

clearEndpoint(String connectionGUID, String endpointGUID)

Remove a relationship between a connection and an endpoint.

void

clearReferenceValueTag(String elementGUID, String validValueGUID)

Remove a reference value assignment relationship between an element and a valid value.

void

clearValidValueMember(String validValueSetGUID, String validValueMemberGUID)

Remove a membership relationship between a validValue and a validValueSet that it belongs to.

void

clearValidValues(String elementGUID, String validValueGUID)

Remove a valid value assignment relationship between an element and a valid value.

String

createConnection(ConnectionProperties connectionProperties)

Create a new metadata element to represent a connection.

String

createConnectionFromTemplate(String templateGUID, TemplateProperties templateProperties)

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

String

createDatabase(DatabaseProperties databaseProperties)

Create a new metadata element to represent a database.

String

createDatabaseColumn(String databaseTableGUID, DatabaseColumnProperties databaseColumnProperties)

Create a new metadata element to represent a database column.

String

createDatabaseColumnFromTemplate(String templateGUID, String databaseTableGUID, TemplateProperties templateProperties)

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

String

createDatabaseFromTemplate(String templateGUID, TemplateProperties templateProperties)

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

String

createDatabaseSchema(String databaseGUID, DatabaseSchemaProperties databaseSchemaProperties)

Create a new metadata element to represent a database schema.

String

createDatabaseSchemaFromTemplate(String templateGUID, String databaseGUID, TemplateProperties templateProperties)

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

String

createDatabaseSchemaType(String qualifiedName)

Create a database top-level schema type used to attach tables and views to the database/database schema.

String

createDatabaseTable(String databaseAssetGUID, DatabaseTableProperties databaseTableProperties)

Create a new metadata element to represent a database table.

String

createDatabaseTableForSchemaType(String databaseSchemaTypeGUID, DatabaseTableProperties databaseTableProperties)

Create a new metadata element to represent a database table.

String

createDatabaseTableFromTemplate(String templateGUID, String databaseAssetGUID, TemplateProperties templateProperties)

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

String

createDatabaseView(String databaseAssetGUID, DatabaseViewProperties databaseViewProperties)

Create a new metadata element to represent a database view.

String

createDatabaseViewForSchemaType(String databaseSchemaTypeGUID, DatabaseViewProperties databaseViewProperties)

Create a new metadata element to represent a database view.

String

createDatabaseViewFromTemplate(String templateGUID, String databaseAssetGUID, TemplateProperties templateProperties)

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

String

createEndpoint(EndpointProperties endpointProperties)

Create a new metadata element to represent an endpoint

String

createEndpointFromTemplate(String networkAddress, String templateGUID, TemplateProperties templateProperties)

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

String

createValidValue(ValidValueProperties validValueProperties)

Create a new metadata element to represent a valid value.

List<ConnectionElement>

findConnections(String searchString, int startFrom, int pageSize)

Retrieve the list of metadata elements that contain the search string.

List<ConnectorTypeElement>

findConnectorTypes(String searchString, int startFrom, int pageSize)

Retrieve the list of connector type metadata elements that contain the search string.

List<DatabaseColumnElement>

findDatabaseColumns(String searchString, int startFrom, int pageSize)

Retrieve the list of database column metadata elements that contain the search string.

List<DatabaseElement>

findDatabases(String searchString, int startFrom, int pageSize)

Retrieve the list of database metadata elements that contain the search string.

List<DatabaseSchemaElement>

findDatabaseSchemas(String searchString, int startFrom, int pageSize)

Retrieve the list of database schema metadata elements that contain the search string.

List<DatabaseTableElement>

findDatabaseTables(String searchString, int startFrom, int pageSize)

Retrieve the list of database table metadata elements that contain the search string.

List<DatabaseViewElement>

findDatabaseViews(String searchString, int startFrom, int pageSize)

Retrieve the list of database view metadata elements that contain the search string.

List<EndpointElement>

findEndpoints(String searchString, int startFrom, int pageSize)

Retrieve the list of endpoint metadata elements that contain the search string.

List<ValidValueElement>

findValidValues(String searchString, int startFrom, int pageSize)

Retrieve the list of metadata elements that contain the search string.

List<ValidValueElement>

getAllValidValues(int startFrom, int pageSize)

Retrieve the list of valid values.

List<RelatedElement>

getAssigneesOfReferenceValue(String validValueGUID, int startFrom, int pageSize)

Return information about the person roles linked to a validValue.

List<DatabaseColumnElement>

getColumnsForDatabaseTable(String databaseTableGUID, int startFrom, int pageSize)

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

ConnectionElement

getConnectionByGUID(String connectionGUID)

Retrieve the metadata element with the supplied unique identifier.

List<ConnectionElement>

getConnectionsByName(String name, int startFrom, int pageSize)

Retrieve the list of metadata elements with a matching qualified or display name.

ConnectorTypeElement

getConnectorTypeByGUID(String connectorTypeGUID)

Retrieve the connector type metadata element with the supplied unique identifier.

List<ConnectorTypeElement>

getConnectorTypesByName(String name, int startFrom, int pageSize)

Retrieve the list of connector type metadata elements with a matching qualified or display name.

List<RelatedElement>

getConsumersOfValidValue(String validValueGUID, int startFrom, int pageSize)

Return information about the consumers linked to a validValue.

DatabaseElement

getDatabaseByGUID(String guid)

Retrieve the database metadata element with the supplied unique identifier.

DatabaseColumnElement

getDatabaseColumnByGUID(String guid)

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

List<DatabaseColumnElement>

getDatabaseColumnsByName(String name, int startFrom, int pageSize)

Retrieve the list of database column metadata elements with a matching qualified or display name.

String

getDatabaseManagerName()

Return the qualified name of the database manager that is supplied in the configuration document.

List<DatabaseElement>

getDatabasesByName(String name, int startFrom, int pageSize)

Retrieve the list of database metadata elements with a matching qualified or display name.

DatabaseSchemaElement

getDatabaseSchemaByGUID(String guid)

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

List<DatabaseSchemaElement>

getDatabaseSchemasByName(String name, int startFrom, int pageSize)

Retrieve the list of database schema metadata elements with a matching qualified or display name.

DatabaseTableElement

getDatabaseTableByGUID(String guid)

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

List<DatabaseTableElement>

getDatabaseTablesByName(String name, int startFrom, int pageSize)

Retrieve the list of database table metadata elements with a matching qualified or display name.

DatabaseViewElement

getDatabaseViewByGUID(String guid)

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

List<DatabaseViewElement>

getDatabaseViewsByName(String name, int startFrom, int pageSize)

Retrieve the list of database view metadata elements with a matching qualified or display name.

EndpointElement

getEndpointByGUID(String endpointGUID)

Retrieve the endpoint metadata element with the supplied unique identifier.

List<EndpointElement>

getEndpointsByName(String name, int startFrom, int pageSize)

Retrieve the list of endpoint metadata elements with a matching qualified or display name.

List<DatabaseElement>

getMyDatabases(int startFrom, int pageSize)

Retrieve the list of databases created by this caller.

List<ValidValueElement>

getReferenceValues(String elementGUID, int startFrom, int pageSize)

Return information about the valid values linked as reference value tags to an element.

List<DatabaseSchemaElement>

getSchemasForDatabase(String databaseGUID, int startFrom, int pageSize)

Return the list of schemas associated with a database.

List<ValidValueElement>

getSetsForValidValue(String validValueGUID, int startFrom, int pageSize)

Page through the list of valid value sets that a valid value definition/set belongs to.

List<DatabaseTableElement>

getTablesForDatabaseAsset(String databaseSchemaGUID, int startFrom, int pageSize)

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

List<DatabaseTableElement>

getTablesForDatabaseSchema(String databaseSchemaGUID, int startFrom, int pageSize)

Deprecated.

ValidValueElement

getValidValueByGUID(String validValueGUID)

Retrieve the metadata element with the supplied unique identifier.

List<ValidValueElement>

getValidValuesByName(String name, int startFrom, int pageSize)

Retrieve the list of metadata elements with a matching qualified or display name.

List<ValidValueElement>

getValidValueSetMembers(String validValueSetGUID, int startFrom, int pageSize)

Page through the members of a valid value set.

ValidValueElement

getValidValuesForConsumer(String elementGUID)

Return information about the valid value set linked to an element as its set of valid values.

List<DatabaseViewElement>

getViewsForDatabaseAsset(String databaseAssetGUID, int startFrom, int pageSize)

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

List<DatabaseViewElement>

getViewsForDatabaseSchema(String databaseSchemaGUID, int startFrom, int pageSize)

Deprecated.

void

publishDatabase(String databaseGUID)

Update the zones for the database asset so that it becomes visible to consumers.

void

publishDatabaseSchema(String databaseSchemaGUID)

Update the zones for the database asset so that it becomes visible to consumers.

void

registerListener(DataManagerEventListener listener)

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

void

removeConnection(String connectionGUID)

Remove the metadata element representing a connection.

void

removeDatabase(String databaseGUID)

Remove the metadata element representing a database.

void

removeDatabase(String databaseGUID, String qualifiedName)

Deprecated.

void

removeDatabaseColumn(String databaseColumnGUID)

Remove the metadata element representing a database column.

void

removeDatabaseColumn(String databaseColumnGUID, String qualifiedName)

Deprecated.

void

removeDatabaseSchema(String databaseSchemaGUID)

Remove the metadata element representing a database schema.

void

removeDatabaseSchema(String databaseSchemaGUID, String qualifiedName)

Deprecated.

void

removeDatabaseTable(String databaseTableGUID)

Remove the metadata element representing a database table.

void

removeDatabaseTable(String databaseTableGUID, String qualifiedName)

Deprecated.

void

removeDatabaseView(String databaseViewGUID)

Remove the metadata element representing a database table.

void

removeDatabaseView(String databaseViewGUID, String qualifiedName)

Deprecated.

void

removeEndpoint(String endpointGUID)

Remove the metadata element representing a endpoint.

void

removeForeignKeyRelationship(String primaryKeyColumnGUID, String foreignKeyColumnGUID)

Remove the foreign key relationship for the requested columns.

void

removePrimaryKeyFromColumn(String databaseColumnGUID)

Remove the classification that this column is a primary key.

void

removeValidValue(String validValueGUID)

Remove the metadata element representing a valid value.

void

setPrimaryKeyOnColumn(String databaseColumnGUID, DatabasePrimaryKeyProperties databasePrimaryKeyProperties)

Classify a column in a database table as the primary key.

void

setupAssetConnection(String assetGUID, String assetSummary, String connectionGUID)

Create a relationship between an asset and its connection.

void

setupConnectorType(String connectionGUID, String connectorTypeGUID)

Create a relationship between a connection and a connector type.

void

setupEmbeddedConnection(String connectionGUID, int position, String displayName, Map<String,Object> arguments, String embeddedConnectionGUID)

Create a relationship between a virtual connection and an embedded connection.

void

setupEndpoint(String connectionGUID, String endpointGUID)

Create a relationship between a connection and an endpoint.

void

setupReferenceValueTag(String elementGUID, ReferenceValueAssignmentProperties properties, String validValueGUID)

Create a reference value assignment relationship between an element and a valid value to show that the valid value is a semiformal tag/classification.

void

setupValidValueMember(String validValueSetGUID, ValidValueMembershipProperties properties, String validValueMemberGUID)

Create a membership relationship between a validValue and a validValueSet that it belongs to.

void

setupValidValues(String elementGUID, ValidValueAssignmentProperties properties, String validValueGUID)

Create a valid value assignment relationship between an element and a valid value (typically, a valid value set) to show that the valid value defines the values that can be stored in the data item that the element represents.

void

updateConnection(String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)

Update the metadata element representing a connection.

void

updateDatabase(String databaseGUID, boolean isMergeUpdate, DatabaseProperties databaseProperties)

Update the metadata element representing a database.

void

updateDatabase(String databaseGUID, DatabaseProperties databaseProperties)

Deprecated.

void

updateDatabaseColumn(String databaseColumnGUID, boolean isMergeUpdate, DatabaseColumnProperties databaseColumnProperties)

Update the metadata element representing a database column.

void

updateDatabaseColumn(String databaseColumnGUID, DatabaseColumnProperties databaseColumnProperties)

Deprecated.

void

updateDatabaseSchema(String databaseSchemaGUID, boolean isMergeUpdate, DatabaseSchemaProperties databaseSchemaProperties)

Update the metadata element representing a database schema.

void

updateDatabaseSchema(String databaseSchemaGUID, DatabaseSchemaProperties databaseSchemaProperties)

Deprecated.

void

updateDatabaseTable(String databaseTableGUID, boolean isMergeUpdate, DatabaseTableProperties databaseTableProperties)

Update the metadata element representing a database table.

void

updateDatabaseTable(String databaseTableGUID, DatabaseTableProperties databaseTableProperties)

Deprecated.

void

updateDatabaseView(String databaseViewGUID, boolean isMergeUpdate, DatabaseViewProperties databaseViewProperties)

Update the metadata element representing a database table.

void

updateDatabaseView(String databaseViewGUID, DatabaseViewProperties databaseViewProperties)

Deprecated.

void

updateEndpoint(boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties)

Update the metadata element representing an endpoint.

void

updateValidValue(String validValueGUID, boolean isMergeUpdate, ValidValueProperties validValueProperties)

Update the metadata element representing a valid value.

void

withdrawDatabase(String databaseGUID)

Update the zones for the database asset so that it is no longer visible to consumers.

void

withdrawDatabaseSchema(String databaseSchemaGUID)

Update the zones for the database asset so that it is no longer visible to consumers.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
addCatalogTarget, addCatalogTarget, disconnect, elementShouldBeCatalogued, getAnchorGUID, getAnchorGUID, getCatalogTarget, getCatalogTargets, getCatalogTargets, getConnectedAssetContext, getExternalSourceIsHome, getFileClassifier, getIntegrationGovernanceContext, getMaxPageSize, getMetadataSourceGUID, getMetadataSourceQualifiedName, getMyUserId, getPermittedSynchronization, isRefreshInProgress, isTypeOf, isTypeOf, registerDirectoryListener, registerDirectoryTreeListener, registerFileListener, removeCatalogTarget, reportAnchorGUID, reportAnchorGUID, reportElementCreation, reportElementDelete, reportElementUpdate, reportParentGUID, setActiveReportPublishing, setExternalSourceIsHome, setMetadataSourceQualifiedName, setMetadataSourceQualifiedName, unregisterDirectoryListener, unregisterDirectoryTreeListener, unregisterFileListener, updateCatalogTarget

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- DatabaseIntegratorContext
  
  public DatabaseIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, OpenIntegrationClient openIntegrationClient, GovernanceConfiguration governanceConfiguration, OpenMetadataClient openMetadataStoreClient, ActionControlInterface actionControlInterface, DatabaseManagerClient databaseManagerClient, ConnectionManagerClient connectionManagerClient, ValidValueManagement validValueManagement, DataManagerEventClient eventClient, boolean generateIntegrationReport, PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String externalSourceGUID, String externalSourceName, AuditLog auditLog, int maxPageSize)
  
  Create a new client with no authentication embedded in the HTTP request.
  
  Parameters:
  
  connectorId - unique identifier of the connector (used to configure the event listener)
  
  connectorName - name of connector from config
  
  connectorUserId - userId for the connector
  
  serverName - name of the integration daemon
  
  openIntegrationClient - client for calling the metadata server
  
  governanceConfiguration - client for managing catalog targets
  
  openMetadataStoreClient - client for calling the metadata server
  
  actionControlInterface - client for initiating governance actions
  
  databaseManagerClient - client to managing database metadata
  
  connectionManagerClient - client for managing connections
  
  validValueManagement - client for managing valid value sets and definitions
  
  eventClient - client to register for events
  
  generateIntegrationReport - should the connector generate an integration reports?
  
  permittedSynchronization - the direction of integration permitted by the integration connector
  
  integrationConnectorGUID - unique identifier for the integration connector if it is started via an integration group (otherwise it is null).
  
  externalSourceGUID - unique identifier of the software server capability for the database manager
  
  externalSourceName - unique name of the software server capability for the database manager
  
  auditLog - logging destination
  
  maxPageSize - max number of elements that can be returned on a query
Method Details
- getDatabaseManagerName
  
  public String getDatabaseManagerName()
  
  Return the qualified name of the database manager that is supplied in the configuration document.
  
  Returns:
  
  string name
- registerListener
  
  public void registerListener(DataManagerEventListener listener) throws InvalidParameterException, ConnectionCheckedException, ConnectorCheckedException, PropertyServerException, UserNotAuthorizedException
  
  Register a listener object that will be passed each of the events published by the Data Manager OMAS.
  
  Parameters:
  
  listener - listener object
  
  Throws:
  
  InvalidParameterException - one of the parameters is null or invalid.
  
  ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
  
  ConnectorCheckedException - there are errors in the initialization of the connector.
  
  PropertyServerException - there is a problem retrieving information from the property server(s).
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- createDatabase
  
  public String createDatabase(DatabaseProperties databaseProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database.
  
  Parameters:
  
  databaseProperties - properties to store
  
  Returns:
  
  unique identifier of the new metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDatabaseFromTemplate
  
  public String createDatabaseFromTemplate(String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database using an existing metadata element as a template.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateDatabase
  
  @Deprecated public void updateDatabase(String databaseGUID, DatabaseProperties databaseProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Update the metadata element representing a database.
  
  Parameters:
  
  databaseGUID - unique identifier of the metadata element to update
  
  databaseProperties - new properties for this element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateDatabase
  
  public void updateDatabase(String databaseGUID, boolean isMergeUpdate, DatabaseProperties databaseProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a database.
  
  Parameters:
  
  databaseGUID - unique identifier of the metadata element to update
  
  databaseProperties - new properties for this element
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- publishDatabase
  
  public void publishDatabase(String databaseGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the database asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).
  
  Parameters:
  
  databaseGUID - unique identifier of the metadata element to publish
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- withdrawDatabase
  
  public void withdrawDatabase(String databaseGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the database asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the database is first created).
  
  Parameters:
  
  databaseGUID - unique identifier of the metadata element to withdraw
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeDatabase
  
  @Deprecated public void removeDatabase(String databaseGUID, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Remove the metadata element representing a database.
  
  Parameters:
  
  databaseGUID - unique identifier of the metadata element to remove
  
  qualifiedName - unique name of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeDatabase
  
  public void removeDatabase(String databaseGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a database.
  
  Parameters:
  
  databaseGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findDatabases
  
  public List<DatabaseElement> findDatabases(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDatabasesByName
  
  public List<DatabaseElement> getDatabasesByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getMyDatabases
  
  public List<DatabaseElement> getMyDatabases(int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of databases created by this caller.
  
  Parameters:
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDatabaseByGUID
  
  public DatabaseElement getDatabaseByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the database metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - unique identifier of the requested metadata element
  
  Returns:
  
  matching metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDatabaseSchema
  
  public String createDatabaseSchema(String databaseGUID, DatabaseSchemaProperties databaseSchemaProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database schema.
  
  Parameters:
  
  databaseGUID - unique identifier of the database where the schema is located
  
  databaseSchemaProperties - properties about the database schema
  
  Returns:
  
  unique identifier of the new database schema
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDatabaseSchemaFromTemplate
  
  public String createDatabaseSchemaFromTemplate(String templateGUID, String databaseGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database schema using an existing metadata element as a template.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  databaseGUID - unique identifier of the database where the schema is located
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new database schema
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateDatabaseSchema
  
  @Deprecated public void updateDatabaseSchema(String databaseSchemaGUID, DatabaseSchemaProperties databaseSchemaProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Update the metadata element representing a database schema.
  
  Parameters:
  
  databaseSchemaGUID - unique identifier of the metadata element to update
  
  databaseSchemaProperties - new properties for the metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateDatabaseSchema
  
  public void updateDatabaseSchema(String databaseSchemaGUID, boolean isMergeUpdate, DatabaseSchemaProperties databaseSchemaProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a database schema.
  
  Parameters:
  
  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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- publishDatabaseSchema
  
  public void publishDatabaseSchema(String databaseSchemaGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the database asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).
  
  Parameters:
  
  databaseSchemaGUID - unique identifier of the metadata element to publish
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- withdrawDatabaseSchema
  
  public void withdrawDatabaseSchema(String databaseSchemaGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the database asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the database is first created).
  
  Parameters:
  
  databaseSchemaGUID - unique identifier of the metadata element to withdraw
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeDatabaseSchema
  
  @Deprecated public void removeDatabaseSchema(String databaseSchemaGUID, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Remove the metadata element representing a database schema.
  
  Parameters:
  
  databaseSchemaGUID - unique identifier of the metadata element to remove
  
  qualifiedName - unique name of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeDatabaseSchema
  
  public void removeDatabaseSchema(String databaseSchemaGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a database schema.
  
  Parameters:
  
  databaseSchemaGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findDatabaseSchemas
  
  public List<DatabaseSchemaElement> findDatabaseSchemas(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database schema metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSchemasForDatabase
  
  public List<DatabaseSchemaElement> getSchemasForDatabase(String databaseGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the list of schemas associated with a database.
  
  Parameters:
  
  databaseGUID - unique identifier of the database to query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of metadata elements describing the schemas associated with the requested database
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDatabaseSchemasByName
  
  public List<DatabaseSchemaElement> getDatabaseSchemasByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database schema metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDatabaseSchemaByGUID
  
  public DatabaseSchemaElement getDatabaseSchemaByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the database schema metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - unique identifier of the requested metadata element
  
  Returns:
  
  requested metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDatabaseSchemaType
  
  public String createDatabaseSchemaType(String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a database top-level schema type used to attach tables and views to the database/database schema.
  
  Parameters:
  
  qualifiedName - qualified name ofr the schema type - suggest "SchemaOf:" + asset's qualified name
  
  Returns:
  
  unique identifier of the database schema type
  
  Throws:
  
  InvalidParameterException - the bean properties are invalid
  
  UserNotAuthorizedException - user not authorized to issue this request
  
  PropertyServerException - problem accessing the property server
- attachSchemaTypeToDatabaseAsset
  
  public void attachSchemaTypeToDatabaseAsset(String databaseAssetGUID, String schemaTypeGUID) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Link the schema type and asset. This is called from outside the AssetHandler. The databaseAssetGUID is checked to ensure the asset exists and updates are allowed. If there is already a schema attached, it is deleted.
  
  Parameters:
  
  databaseAssetGUID - unique identifier of the asset to connect the schema to
  
  schemaTypeGUID - identifier for schema Type object
  
  Throws:
  
  InvalidParameterException - the bean properties are invalid
  
  UserNotAuthorizedException - user not authorized to issue this request
  
  PropertyServerException - problem accessing the property server
- createDatabaseTable
  
  public String createDatabaseTable(String databaseAssetGUID, DatabaseTableProperties databaseTableProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database table.
  
  Parameters:
  
  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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDatabaseTableFromTemplate
  
  public String createDatabaseTableFromTemplate(String templateGUID, String databaseAssetGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database table using an existing metadata element as a template.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDatabaseTableForSchemaType
  
  public String createDatabaseTableForSchemaType(String databaseSchemaTypeGUID, DatabaseTableProperties databaseTableProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database table.
  
  Parameters:
  
  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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateDatabaseTable
  
  @Deprecated public void updateDatabaseTable(String databaseTableGUID, DatabaseTableProperties databaseTableProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Update the metadata element representing a database table.
  
  Parameters:
  
  databaseTableGUID - unique identifier of the database table to update
  
  databaseTableProperties - new properties for the database table
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateDatabaseTable
  
  public void updateDatabaseTable(String databaseTableGUID, boolean isMergeUpdate, DatabaseTableProperties databaseTableProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a database table.
  
  Parameters:
  
  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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeDatabaseTable
  
  @Deprecated public void removeDatabaseTable(String databaseTableGUID, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Remove the metadata element representing a database table.
  
  Parameters:
  
  databaseTableGUID - unique identifier of the metadata element to remove
  
  qualifiedName - unique name of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeDatabaseTable
  
  public void removeDatabaseTable(String databaseTableGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a database table.
  
  Parameters:
  
  databaseTableGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findDatabaseTables
  
  public List<DatabaseTableElement> findDatabaseTables(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database table metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getTablesForDatabaseSchema
  
  @Deprecated public List<DatabaseTableElement> getTablesForDatabaseSchema(String databaseSchemaGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Retrieve the list of database tables associated with a database schema.
  
  Parameters:
  
  databaseSchemaGUID - unique identifier of the database schema of interest
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of associated metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getTablesForDatabaseAsset
  
  public List<DatabaseTableElement> getTablesForDatabaseAsset(String databaseSchemaGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database tables associated with a database or database schema.
  
  Parameters:
  
  databaseSchemaGUID - 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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDatabaseTablesByName
  
  public List<DatabaseTableElement> getDatabaseTablesByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database table metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDatabaseTableByGUID
  
  public DatabaseTableElement getDatabaseTableByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the database table metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - unique identifier of the requested metadata element
  
  Returns:
  
  matching metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDatabaseView
  
  public String createDatabaseView(String databaseAssetGUID, DatabaseViewProperties databaseViewProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database view.
  
  Parameters:
  
  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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDatabaseViewFromTemplate
  
  public String createDatabaseViewFromTemplate(String templateGUID, String databaseAssetGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database view using an existing metadata element as a template.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDatabaseViewForSchemaType
  
  public String createDatabaseViewForSchemaType(String databaseSchemaTypeGUID, DatabaseViewProperties databaseViewProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database view.
  
  Parameters:
  
  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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateDatabaseView
  
  @Deprecated public void updateDatabaseView(String databaseViewGUID, DatabaseViewProperties databaseViewProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Update the metadata element representing a database table.
  
  Parameters:
  
  databaseViewGUID - unique identifier of the database view to update
  
  databaseViewProperties - properties for the new database view
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateDatabaseView
  
  public void updateDatabaseView(String databaseViewGUID, boolean isMergeUpdate, DatabaseViewProperties databaseViewProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a database table.
  
  Parameters:
  
  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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeDatabaseView
  
  @Deprecated public void removeDatabaseView(String databaseViewGUID, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Remove the metadata element representing a database table.
  
  Parameters:
  
  databaseViewGUID - unique identifier of the metadata element to remove
  
  qualifiedName - unique name of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeDatabaseView
  
  public void removeDatabaseView(String databaseViewGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a database table.
  
  Parameters:
  
  databaseViewGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findDatabaseViews
  
  public List<DatabaseViewElement> findDatabaseViews(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database view metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getViewsForDatabaseSchema
  
  @Deprecated public List<DatabaseViewElement> getViewsForDatabaseSchema(String databaseSchemaGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Retrieve the list of database views associated with a database schema.
  
  Parameters:
  
  databaseSchemaGUID - unique identifier of the database schema of interest
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of associated metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getViewsForDatabaseAsset
  
  public List<DatabaseViewElement> getViewsForDatabaseAsset(String databaseAssetGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database views associated with a database schema.
  
  Parameters:
  
  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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDatabaseViewsByName
  
  public List<DatabaseViewElement> getDatabaseViewsByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database view metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDatabaseViewByGUID
  
  public DatabaseViewElement getDatabaseViewByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the database view metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - unique identifier of the requested metadata element
  
  Returns:
  
  matching metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDatabaseColumn
  
  public String createDatabaseColumn(String databaseTableGUID, DatabaseColumnProperties databaseColumnProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database column.
  
  Parameters:
  
  databaseTableGUID - unique identifier of the database table where this column is located
  
  databaseColumnProperties - properties for the new column
  
  Returns:
  
  unique identifier of the new metadata element for the database column
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDatabaseColumnFromTemplate
  
  public String createDatabaseColumnFromTemplate(String templateGUID, String databaseTableGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a database column using an existing metadata element as a template.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  databaseTableGUID - unique identifier of the database table where this column is located
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new metadata element for the database column
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateDatabaseColumn
  
  @Deprecated public void updateDatabaseColumn(String databaseColumnGUID, DatabaseColumnProperties databaseColumnProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Update the metadata element representing a database column.
  
  Parameters:
  
  databaseColumnGUID - unique identifier of the metadata element to update
  
  databaseColumnProperties - new properties for the metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateDatabaseColumn
  
  public void updateDatabaseColumn(String databaseColumnGUID, boolean isMergeUpdate, DatabaseColumnProperties databaseColumnProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a database column.
  
  Parameters:
  
  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:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeDatabaseColumn
  
  @Deprecated public void removeDatabaseColumn(String databaseColumnGUID, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Remove the metadata element representing a database column.
  
  Parameters:
  
  databaseColumnGUID - unique identifier of the metadata element to remove
  
  qualifiedName - unique name of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeDatabaseColumn
  
  public void removeDatabaseColumn(String databaseColumnGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a database column.
  
  Parameters:
  
  databaseColumnGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findDatabaseColumns
  
  public List<DatabaseColumnElement> findDatabaseColumns(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database column metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getColumnsForDatabaseTable
  
  public List<DatabaseColumnElement> getColumnsForDatabaseTable(String databaseTableGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of column for a database table (or view)
  
  Parameters:
  
  databaseTableGUID - unique identifier of the database table of interest
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDatabaseColumnsByName
  
  public List<DatabaseColumnElement> getDatabaseColumnsByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of database column metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDatabaseColumnByGUID
  
  public DatabaseColumnElement getDatabaseColumnByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the database column metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - unique identifier of the requested metadata element
  
  Returns:
  
  matching metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setPrimaryKeyOnColumn
  
  public void setPrimaryKeyOnColumn(String databaseColumnGUID, DatabasePrimaryKeyProperties databasePrimaryKeyProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Classify a column in a database table as the primary key. This means each row has a different value in this column, and it can be used to uniquely identify the column.
  
  Parameters:
  
  databaseColumnGUID - unique identifier if the primary key column
  
  databasePrimaryKeyProperties - properties to store
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removePrimaryKeyFromColumn
  
  public void removePrimaryKeyFromColumn(String databaseColumnGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the classification that this column is a primary key.
  
  Parameters:
  
  databaseColumnGUID - unique identifier if the primary key column
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- addForeignKeyRelationship
  
  public void addForeignKeyRelationship(String primaryKeyColumnGUID, String foreignKeyColumnGUID, DatabaseForeignKeyProperties databaseForeignKeyProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a foreign relationship between two columns. One of the columns holds the primary key of the other to form a link.
  
  Parameters:
  
  primaryKeyColumnGUID - unique identifier of the column containing the primary key
  
  foreignKeyColumnGUID - unique identifier of the column containing the primary key from the other table
  
  databaseForeignKeyProperties - properties about the foreign key relationship
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeForeignKeyRelationship
  
  public void removeForeignKeyRelationship(String primaryKeyColumnGUID, String foreignKeyColumnGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the foreign key relationship for the requested columns.
  
  Parameters:
  
  primaryKeyColumnGUID - unique identifier of the column that is the linked primary key
  
  foreignKeyColumnGUID - unique identifier of the column the contains the primary key from another table
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createConnection
  
  public String createConnection(ConnectionProperties connectionProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a connection.
  
  Parameters:
  
  connectionProperties - properties about the connection to store
  
  Returns:
  
  unique identifier of the new connection
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createConnectionFromTemplate
  
  public String createConnectionFromTemplate(String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a connection using an existing metadata element as a template.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new connection
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateConnection
  
  public void updateConnection(String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a connection. It is possible to use the subtype property classes or set up specialized properties in extended properties.
  
  Parameters:
  
  connectionGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  connectionProperties - new properties for the metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupConnectorType
  
  public void setupConnectorType(String connectionGUID, String connectorTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between a connection and a connector type.
  
  Parameters:
  
  connectionGUID - unique identifier of the connection in the external data manager
  
  connectorTypeGUID - unique identifier of the connector type in the external data manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearConnectorType
  
  public void clearConnectorType(String connectionGUID, String connectorTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between a connection and a connector type.
  
  Parameters:
  
  connectionGUID - unique identifier of the connection in the external data manager
  
  connectorTypeGUID - unique identifier of the connector type in the external data manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupEndpoint
  
  public void setupEndpoint(String connectionGUID, String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between a connection and an endpoint.
  
  Parameters:
  
  connectionGUID - unique identifier of the connection in the external data manager
  
  endpointGUID - unique identifier of the endpoint in the external data manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearEndpoint
  
  public void clearEndpoint(String connectionGUID, String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between a connection and an endpoint.
  
  Parameters:
  
  connectionGUID - unique identifier of the connection in the external data manager
  
  endpointGUID - unique identifier of the endpoint in the external data manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupEmbeddedConnection
  
  public void setupEmbeddedConnection(String connectionGUID, int position, String displayName, Map<String,Object> arguments, String embeddedConnectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between a virtual connection and an embedded connection.
  
  Parameters:
  
  connectionGUID - unique identifier of the virtual connection in the external data manager
  
  position - which order should this connection be processed
  
  arguments - What additional properties should be passed to the embedded connector via the configuration properties
  
  displayName - what does this connector signify?
  
  embeddedConnectionGUID - unique identifier of the embedded connection in the external data manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearEmbeddedConnection
  
  public void clearEmbeddedConnection(String connectionGUID, String embeddedConnectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between a virtual connection and an embedded connection.
  
  Parameters:
  
  connectionGUID - unique identifier of the virtual connection in the external data manager
  
  embeddedConnectionGUID - unique identifier of the embedded connection in the external data manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupAssetConnection
  
  public void setupAssetConnection(String assetGUID, String assetSummary, String connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between an asset and its connection.
  
  Parameters:
  
  assetGUID - unique identifier of the asset
  
  assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.
  
  connectionGUID - unique identifier of the connection
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearAssetConnection
  
  public void clearAssetConnection(String assetGUID, String connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between an asset and its connection.
  
  Parameters:
  
  assetGUID - unique identifier of the asset
  
  connectionGUID - unique identifier of the connection
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeConnection
  
  public void removeConnection(String connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a connection.
  
  Parameters:
  
  connectionGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findConnections
  
  public List<ConnectionElement> findConnections(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getConnectionsByName
  
  public List<ConnectionElement> getConnectionsByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name used to retrieve the connection
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getConnectionByGUID
  
  public ConnectionElement getConnectionByGUID(String connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the metadata element with the supplied unique identifier.
  
  Parameters:
  
  connectionGUID - unique identifier of the requested metadata element
  
  Returns:
  
  requested metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createEndpoint
  
  public String createEndpoint(EndpointProperties endpointProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an endpoint
  
  Parameters:
  
  endpointProperties - properties about the endpoint to store
  
  Returns:
  
  unique identifier of the new endpoint
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createEndpointFromTemplate
  
  public String createEndpointFromTemplate(String networkAddress, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a endpoint using an existing metadata element as a template.
  
  Parameters:
  
  networkAddress - location of the endpoint
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - descriptive properties that override the template
  
  Returns:
  
  unique identifier of the new endpoint
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateEndpoint
  
  public void updateEndpoint(boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing an endpoint. It is possible to use the subtype property classes or set up specialized properties in extended properties.
  
  Parameters:
  
  endpointGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  endpointProperties - new properties for the metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeEndpoint
  
  public void removeEndpoint(String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a endpoint.
  
  Parameters:
  
  endpointGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findEndpoints
  
  public List<EndpointElement> findEndpoints(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of endpoint metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getEndpointsByName
  
  public List<EndpointElement> getEndpointsByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getEndpointByGUID
  
  public EndpointElement getEndpointByGUID(String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the endpoint metadata element with the supplied unique identifier.
  
  Parameters:
  
  endpointGUID - unique identifier of the requested metadata element
  
  Returns:
  
  requested metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findConnectorTypes
  
  public List<ConnectorTypeElement> findConnectorTypes(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of connector type metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getConnectorTypesByName
  
  public List<ConnectorTypeElement> getConnectorTypesByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of connector type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getConnectorTypeByGUID
  
  public ConnectorTypeElement getConnectorTypeByGUID(String connectorTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the connector type metadata element with the supplied unique identifier.
  
  Parameters:
  
  connectorTypeGUID - unique identifier of the requested metadata element
  
  Returns:
  
  requested metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createValidValue
  
  public String createValidValue(ValidValueProperties validValueProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a valid value.
  
  Parameters:
  
  validValueProperties - properties about the valid value to store
  
  Returns:
  
  unique identifier of the new valid value
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateValidValue
  
  public void updateValidValue(String validValueGUID, boolean isMergeUpdate, ValidValueProperties validValueProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a valid value. It is possible to use the subtype property classes or set up specialized properties in extended properties.
  
  Parameters:
  
  validValueGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  validValueProperties - new properties for the metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupValidValueMember
  
  public void setupValidValueMember(String validValueSetGUID, ValidValueMembershipProperties properties, String validValueMemberGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a membership relationship between a validValue and a validValueSet that it belongs to.
  
  Parameters:
  
  validValueSetGUID - unique identifier of the valid value set
  
  properties - describes the properties of the membership
  
  validValueMemberGUID - unique identifier of the member
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearValidValueMember
  
  public void clearValidValueMember(String validValueSetGUID, String validValueMemberGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a membership relationship between a validValue and a validValueSet that it belongs to.
  
  Parameters:
  
  validValueSetGUID - unique identifier of the valid value set
  
  validValueMemberGUID - unique identifier of the member
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupValidValues
  
  public void setupValidValues(String elementGUID, ValidValueAssignmentProperties properties, String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a valid value assignment relationship between an element and a valid value (typically, a valid value set) to show that the valid value defines the values that can be stored in the data item that the element represents.
  
  Parameters:
  
  elementGUID - unique identifier of the element
  
  properties - describes the permissions that the role has in the validValue
  
  validValueGUID - unique identifier of the valid value
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearValidValues
  
  public void clearValidValues(String elementGUID, String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a valid value assignment relationship between an element and a valid value.
  
  Parameters:
  
  elementGUID - unique identifier of the element
  
  validValueGUID - unique identifier of the valid value
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupReferenceValueTag
  
  public void setupReferenceValueTag(String elementGUID, ReferenceValueAssignmentProperties properties, String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a reference value assignment relationship between an element and a valid value to show that the valid value is a semiformal tag/classification.
  
  Parameters:
  
  elementGUID - unique identifier of the element
  
  properties - describes the quality of the assignment
  
  validValueGUID - unique identifier of the valid value
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearReferenceValueTag
  
  public void clearReferenceValueTag(String elementGUID, String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a reference value assignment relationship between an element and a valid value.
  
  Parameters:
  
  elementGUID - unique identifier of the element
  
  validValueGUID - unique identifier of the valid value
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeValidValue
  
  public void removeValidValue(String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a valid value.
  
  Parameters:
  
  validValueGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findValidValues
  
  public List<ValidValueElement> findValidValues(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getValidValuesByName
  
  public List<ValidValueElement> getValidValuesByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAllValidValues
  
  public List<ValidValueElement> getAllValidValues(int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of valid values.
  
  Parameters:
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getValidValueSetMembers
  
  public List<ValidValueElement> getValidValueSetMembers(String validValueSetGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Page through the members of a valid value set.
  
  Parameters:
  
  validValueSetGUID - unique identifier of the valid value set
  
  startFrom - paging starting point
  
  pageSize - maximum number of return values.
  
  Returns:
  
  list of valid value beans
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid.
  
  UserNotAuthorizedException - the user is not authorized to make this request.
  
  PropertyServerException - the repository is not available or not working properly.
- getSetsForValidValue
  
  public List<ValidValueElement> getSetsForValidValue(String validValueGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Page through the list of valid value sets that a valid value definition/set belongs to.
  
  Parameters:
  
  validValueGUID - unique identifier of valid value to query
  
  startFrom - paging starting point
  
  pageSize - maximum number of return values.
  
  Returns:
  
  list of valid value beans
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid.
  
  UserNotAuthorizedException - the user is not authorized to make this request.
  
  PropertyServerException - the repository is not available or not working properly.
- getValidValuesForConsumer
  
  public ValidValueElement getValidValuesForConsumer(String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the valid value set linked to an element as its set of valid values.
  
  Parameters:
  
  elementGUID - unique identifier for the element using the valid value set
  
  Returns:
  
  list of matching actor profiles (hopefully only one)
  
  Throws:
  
  InvalidParameterException - guid is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getConsumersOfValidValue
  
  public List<RelatedElement> getConsumersOfValidValue(String validValueGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the consumers linked to a validValue.
  
  Parameters:
  
  validValueGUID - unique identifier for the validValue
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of matching actor profiles (hopefully only one)
  
  Throws:
  
  InvalidParameterException - guid is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getReferenceValues
  
  public List<ValidValueElement> getReferenceValues(String elementGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the valid values linked as reference value tags to an element.
  
  Parameters:
  
  elementGUID - unique identifier for the element
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of valid values
  
  Throws:
  
  InvalidParameterException - guid is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getAssigneesOfReferenceValue
  
  public List<RelatedElement> getAssigneesOfReferenceValue(String validValueGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the person roles linked to a validValue.
  
  Parameters:
  
  validValueGUID - unique identifier for the validValue
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of matching actor profiles (hopefully only one)
  
  Throws:
  
  InvalidParameterException - guid is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getValidValueByGUID
  
  public ValidValueElement getValidValueByGUID(String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the metadata element with the supplied unique identifier.
  
  Parameters:
  
  validValueGUID - unique identifier of the requested metadata element
  
  Returns:
  
  requested metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)

Class DatabaseIntegratorContext

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

Methods inherited from class java.lang.Object

Constructor Details

DatabaseIntegratorContext

Method Details

getDatabaseManagerName

registerListener

createDatabase

createDatabaseFromTemplate

updateDatabase

updateDatabase

publishDatabase

withdrawDatabase

removeDatabase

removeDatabase

findDatabases

getDatabasesByName

getMyDatabases

getDatabaseByGUID

createDatabaseSchema

createDatabaseSchemaFromTemplate

updateDatabaseSchema

updateDatabaseSchema

publishDatabaseSchema

withdrawDatabaseSchema

removeDatabaseSchema

removeDatabaseSchema

findDatabaseSchemas

getSchemasForDatabase

getDatabaseSchemasByName

getDatabaseSchemaByGUID

createDatabaseSchemaType

attachSchemaTypeToDatabaseAsset

createDatabaseTable

createDatabaseTableFromTemplate

createDatabaseTableForSchemaType

updateDatabaseTable

updateDatabaseTable

removeDatabaseTable

removeDatabaseTable

findDatabaseTables

getTablesForDatabaseSchema

getTablesForDatabaseAsset

getDatabaseTablesByName

getDatabaseTableByGUID

createDatabaseView

createDatabaseViewFromTemplate

createDatabaseViewForSchemaType

updateDatabaseView

updateDatabaseView

removeDatabaseView

removeDatabaseView

findDatabaseViews

getViewsForDatabaseSchema

getViewsForDatabaseAsset

getDatabaseViewsByName

getDatabaseViewByGUID

createDatabaseColumn

createDatabaseColumnFromTemplate

updateDatabaseColumn

updateDatabaseColumn

removeDatabaseColumn

removeDatabaseColumn

findDatabaseColumns

getColumnsForDatabaseTable

getDatabaseColumnsByName

getDatabaseColumnByGUID

setPrimaryKeyOnColumn

removePrimaryKeyFromColumn

addForeignKeyRelationship

removeForeignKeyRelationship

createConnection

createConnectionFromTemplate

updateConnection

setupConnectorType