public class RelationalDataHandler extends Object
| Constructor and Description |
|---|
RelationalDataHandler(String serviceName,
String serverName,
InvalidParameterHandler invalidParameterHandler,
RepositoryHandler repositoryHandler,
OMRSRepositoryHelper repositoryHelper,
List<String> defaultZones,
List<String> supportedZones,
List<String> publishZones,
AssetHandler assetHandler,
ConnectionHandler connectionHandler,
SchemaTypeHandler schemaTypeHandler,
SoftwareServerCapabilityHandler softwareServerCapabilityHandler,
GlossaryTermHandler glossaryTermHandler)
Construct the relational data handler with information needed to work with assets, schemas, software server capability and connection objects.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addForeignKeyRelationship(String userId,
String integratorGUID,
String integratorName,
String primaryKeyColumnGUID,
String foreignKeyColumnGUID,
String name,
String description,
int confidence,
String steward,
String source,
String methodName)
Create a foreign relationship between two columns.
|
String |
createDatabase(String userId,
String integratorGUID,
String integratorName,
String qualifiedName,
String displayName,
String description,
String owner,
OwnerType ownerType,
List<String> zoneMembership,
Map<String,String> origin,
String latestChange,
Date createTime,
Date modifiedTime,
String encodingType,
String encodingLanguage,
String encodingDescription,
String databaseType,
String databaseVersion,
String databaseInstance,
String databaseImportedFrom,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
String methodName)
Create a new metadata element to represent a database that is owned by an external element.
|
String |
createDatabaseColumn(String userId,
String integratorGUID,
String integratorName,
String databaseTableGUID,
String qualifiedName,
String displayName,
String description,
String dataType,
String defaultValue,
String formula,
List<SchemaImplementationQuery> queries,
boolean isDeprecated,
int elementPosition,
int minCardinality,
int maxCardinality,
boolean allowsDuplicateValues,
boolean orderedValues,
String defaultValueOverride,
DataItemSortOrder sortOrder,
int minimumLength,
int length,
int significantDigits,
boolean isNullable,
String nativeJavaClass,
List<String> aliases,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
String methodName)
Create a new metadata element to represent a database column.
|
String |
createDatabaseColumnFromTemplate(String userId,
String integratorGUID,
String integratorName,
String templateGUID,
String databaseTableGUID,
String qualifiedName,
String displayName,
String description,
String methodName)
Create a new metadata element to represent a database column using an existing metadata element as a template.
|
String |
createDatabaseFromTemplate(String userId,
String integratorGUID,
String integratorName,
String templateGUID,
String qualifiedName,
String displayName,
String description,
String methodName)
Create a new metadata element to represent a database using an existing metadata element as a template.
|
String |
createDatabaseSchema(String userId,
String integratorGUID,
String integratorName,
String databaseGUID,
String qualifiedName,
String displayName,
String description,
String owner,
OwnerType ownerType,
List<String> zoneMembership,
Map<String,String> origin,
String latestChange,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
String methodName)
Create a new metadata element to represent a database schema.
|
String |
createDatabaseSchemaFromTemplate(String userId,
String integratorGUID,
String integratorName,
String templateGUID,
String databaseGUID,
String qualifiedName,
String displayName,
String description,
String methodName)
Create a new metadata element to represent a database schema using an existing metadata element as a template.
|
String |
createDatabaseTable(String userId,
String integratorGUID,
String integratorName,
String databaseSchemaGUID,
String qualifiedName,
String displayName,
String description,
boolean isDeprecated,
List<String> aliases,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
String methodName)
Create a new metadata element to represent a database table.
|
String |
createDatabaseTableFromTemplate(String userId,
String integratorGUID,
String integratorName,
String templateGUID,
String databaseSchemaGUID,
String qualifiedName,
String displayName,
String description,
String methodName)
Create a new metadata element to represent a database table using an existing metadata element as a template.
|
String |
createDatabaseView(String userId,
String integratorGUID,
String integratorName,
String databaseSchemaGUID,
String qualifiedName,
String displayName,
String description,
boolean isDeprecated,
List<String> aliases,
String expression,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
String methodName)
Create a new metadata element to represent a database view.
|
String |
createDatabaseViewFromTemplate(String userId,
String integratorGUID,
String integratorName,
String templateGUID,
String databaseSchemaGUID,
String qualifiedName,
String displayName,
String description,
String methodName)
Create a new metadata element to represent a database view using an existing metadata element as a template.
|
List<SchemaAttribute> |
findDatabaseColumns(String userId,
String searchString,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database column metadata elements that contain the search string.
|
List<Asset> |
findDatabases(String userId,
String searchString,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database metadata elements that contain the search string.
|
List<Asset> |
findDatabaseSchemas(String userId,
String searchString,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database schema metadata elements that contain the search string.
|
List<SchemaAttribute> |
findDatabaseTables(String userId,
String searchString,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database table metadata elements that contain the search string.
|
List<SchemaAttribute> |
findDatabaseViews(String userId,
String searchString,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database view metadata elements that contain the search string.
|
List<SchemaAttribute> |
getColumnsForDatabaseTable(String userId,
String databaseTableGUID,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of column for a database table (or view)
|
Asset |
getDatabaseByGUID(String userId,
String guid,
String methodName)
Retrieve the database metadata element with the supplied unique identifier.
|
SchemaAttribute |
getDatabaseColumnByGUID(String userId,
String guid,
String methodName)
Retrieve the database column metadata element with the supplied unique identifier.
|
List<SchemaAttribute> |
getDatabaseColumnsByName(String userId,
String name,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database column metadata elements with a matching qualified or display name.
|
List<Asset> |
getDatabasesByDaemon(String userId,
String integratorGUID,
String integratorName,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of databases created by this caller.
|
List<Asset> |
getDatabasesByName(String userId,
String name,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database metadata elements with a matching qualified or display name.
|
Asset |
getDatabaseSchemaByGUID(String userId,
String guid,
String methodName)
Retrieve the database schema metadata element with the supplied unique identifier.
|
List<Asset> |
getDatabaseSchemasByName(String userId,
String name,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database schema metadata elements with a matching qualified or display name.
|
SchemaAttribute |
getDatabaseTableByGUID(String userId,
String guid,
String methodName)
Retrieve the database table metadata element with the supplied unique identifier.
|
List<SchemaAttribute> |
getDatabaseTablesByName(String userId,
String name,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database table metadata elements with a matching qualified or display name.
|
SchemaAttribute |
getDatabaseViewByGUID(String userId,
String guid,
String methodName)
Retrieve the database view metadata element with the supplied unique identifier.
|
List<SchemaAttribute> |
getDatabaseViewsByName(String userId,
String name,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database view metadata elements with a matching qualified or display name.
|
List<Asset> |
getSchemasForDatabase(String userId,
String databaseGUID,
int startFrom,
int pageSize,
String methodName)
Return the list of (deployed database) schemas associated with a database.
|
List<SchemaAttribute> |
getTablesForDatabaseSchema(String userId,
String databaseSchemaGUID,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database tables associated with a database schema.
|
List<SchemaAttribute> |
getViewsForDatabaseSchema(String userId,
String databaseSchemaGUID,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database views associated with a database schema.
|
void |
publishDatabase(String userId,
String integratorGUID,
String integratorName,
String databaseGUID,
String methodName)
Update the zones for the database asset so that it becomes visible to consumers.
|
void |
publishDatabaseSchema(String userId,
String integratorGUID,
String integratorName,
String databaseSchemaGUID,
String methodName)
Update the zones for the database asset so that it becomes visible to consumers.
|
void |
removeDatabase(String userId,
String integratorGUID,
String integratorName,
String databaseGUID,
String qualifiedName,
String methodName)
Remove the metadata element representing a database.
|
void |
removeDatabaseColumn(String userId,
String integratorGUID,
String integratorName,
String databaseColumnGUID,
String qualifiedName,
String methodName)
Remove the metadata element representing a database column.
|
void |
removeDatabaseSchema(String userId,
String integratorGUID,
String integratorName,
String databaseSchemaGUID,
String qualifiedName,
String methodName)
Remove the metadata element representing a database schema.
|
void |
removeDatabaseTable(String userId,
String integratorGUID,
String integratorName,
String databaseTableGUID,
String qualifiedName,
String methodName)
Remove the metadata element representing a database table.
|
void |
removeDatabaseView(String userId,
String integratorGUID,
String integratorName,
String databaseViewGUID,
String qualifiedName,
String methodName)
Remove the metadata element representing a database table.
|
void |
removeForeignKeyRelationship(String userId,
String integratorGUID,
String integratorName,
String primaryKeyColumnGUID,
String foreignKeyColumnGUID,
String methodName)
Remove the foreign key relationship for the requested columns.
|
void |
removePrimaryKeyFromColumn(String userId,
String integratorGUID,
String integratorName,
String databaseColumnGUID,
String methodName)
Remove the classification that this column is a primary key.
|
void |
setPrimaryKeyOnColumn(String userId,
String integratorGUID,
String integratorName,
String databaseColumnGUID,
String name,
KeyPattern keyPattern,
String methodName)
Classify a column in a database table as the primary key.
|
void |
updateDatabase(String userId,
String integratorGUID,
String integratorName,
String databaseGUID,
String qualifiedName,
String displayName,
String description,
String owner,
OwnerType ownerType,
List<String> zoneMembership,
Map<String,String> origin,
String latestChange,
Date createTime,
Date modifiedTime,
String encodingType,
String encodingLanguage,
String encodingDescription,
String databaseType,
String databaseVersion,
String databaseInstance,
String databaseImportedFrom,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
String methodName)
Update the metadata element representing a database.
|
void |
updateDatabaseColumn(String userId,
String integratorGUID,
String integratorName,
String databaseColumnGUID,
String qualifiedName,
String displayName,
String description,
String dataType,
String defaultValue,
String formula,
List<SchemaImplementationQuery> queries,
boolean isDeprecated,
int elementPosition,
int minCardinality,
int maxCardinality,
boolean allowsDuplicateValues,
boolean orderedValues,
String defaultValueOverride,
DataItemSortOrder sortOrder,
int minimumLength,
int length,
int significantDigits,
boolean isNullable,
String nativeJavaClass,
List<String> aliases,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
String methodName)
Update the metadata element representing a database column.
|
void |
updateDatabaseDerivedColumn(String userId,
String integratorGUID,
String integratorName,
String databaseColumnGUID,
String qualifiedName,
String displayName,
String description,
boolean isDeprecated,
int elementPosition,
int minCardinality,
int maxCardinality,
boolean allowsDuplicateValues,
boolean orderedValues,
String defaultValueOverride,
DataItemSortOrder sortOrder,
int minimumLength,
int length,
int significantDigits,
boolean isNullable,
String nativeJavaClass,
List<String> aliases,
String expression,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
String methodName)
Update the metadata element representing a database derived column.
|
void |
updateDatabaseSchema(String userId,
String integratorGUID,
String integratorName,
String databaseSchemaGUID,
String qualifiedName,
String displayName,
String description,
String owner,
OwnerType ownerType,
List<String> zoneMembership,
Map<String,String> origin,
String latestChange,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
String methodName)
Update the metadata element representing a database schema.
|
void |
updateDatabaseTable(String userId,
String integratorGUID,
String integratorName,
String databaseTableGUID,
String qualifiedName,
String displayName,
String description,
boolean isDeprecated,
List<String> aliases,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
String methodName)
Update the metadata element representing a database table.
|
void |
updateDatabaseView(String userId,
String integratorGUID,
String integratorName,
String databaseViewGUID,
String qualifiedName,
String displayName,
String description,
boolean isDeprecated,
List<String> aliases,
String expression,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
String methodName)
Update the metadata element representing a database table.
|
void |
withdrawDatabase(String userId,
String integratorGUID,
String integratorName,
String databaseGUID,
String methodName)
Update the zones for the database asset so that it is no longer visible to consumers.
|
void |
withdrawDatabaseSchema(String userId,
String integratorGUID,
String integratorName,
String databaseSchemaGUID,
String methodName)
Update the zones for the database asset so that it is no longer visible to consumers.
|
public RelationalDataHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, List<String> defaultZones, List<String> supportedZones, List<String> publishZones, AssetHandler assetHandler, ConnectionHandler connectionHandler, SchemaTypeHandler schemaTypeHandler, SoftwareServerCapabilityHandler softwareServerCapabilityHandler, GlossaryTermHandler glossaryTermHandler)
serviceName - name of this serviceserverName - name of the local serverinvalidParameterHandler - handler for managing parameter errorsrepositoryHandler - handler for interfacing with the repository servicesrepositoryHelper - helper utilities for managing repository services objectsdefaultZones - list of default zonessupportedZones - list of supported zonespublishZones - list of publish zonesassetHandler - handler for managing assetsconnectionHandler - handler for managing connectionsschemaTypeHandler - handler for schema elementssoftwareServerCapabilityHandler - handler for file systemsglossaryTermHandler - handler for glossary termspublic String createDatabase(String userId, String integratorGUID, String integratorName, String qualifiedName, String displayName, String description, String owner, OwnerType ownerType, List<String> zoneMembership, Map<String,String> origin, String latestChange, Date createTime, Date modifiedTime, String encodingType, String encodingLanguage, String encodingDescription, String databaseType, String databaseVersion, String databaseInstance, String databaseImportedFrom, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerqualifiedName - unique name for this databasedisplayName - the stored display name property for the databasedescription - the stored description property associated with the databaseowner - identifier of the ownerownerType - is the owner identifier a user id, personal profile or team profilezoneMembership - governance zones for the database - null means use the default zones set for this serviceorigin - the properties that characterize where this database is fromlatestChange - latest change string for the databasecreateTime - the time that the database was createdmodifiedTime - the last known time the data store was modifiedencodingType - the name of the encoding style used in the databaseencodingLanguage - the name of the natural language used for text strings within the databaseencodingDescription - the description of the encoding used in the databasedatabaseType - a description of the database typedatabaseVersion - the version of the database - often this is related to the version of its schemas.databaseInstance - the name of this database instance - useful if the same schemas are deployed to multiple database instancesdatabaseImportedFrom - the source (typically connection name) of the database informationadditionalProperties - any arbitrary properties not part of the type systemtypeName - name of the type that is a subtype of Database - or null to create standard typeextendedProperties - properties from any subtypemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public String createDatabaseFromTemplate(String userId, String integratorGUID, String integratorName, String templateGUID, String qualifiedName, String displayName, String description, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callertemplateGUID - unique identifier of the metadata element to copyqualifiedName - unique name for this database - must not be nulldisplayName - the stored display name property for the database - if null, the value from the template is useddescription - the stored description property associated with the database - if null, the value from the template is used.methodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void updateDatabase(String userId, String integratorGUID, String integratorName, String databaseGUID, String qualifiedName, String displayName, String description, String owner, OwnerType ownerType, List<String> zoneMembership, Map<String,String> origin, String latestChange, Date createTime, Date modifiedTime, String encodingType, String encodingLanguage, String encodingDescription, String databaseType, String databaseVersion, String databaseInstance, String databaseImportedFrom, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseGUID - unique identifier of the metadata element to updatequalifiedName - unique name for this databasedisplayName - the stored display name property for the databasedescription - the stored description property associated with the databaseowner - identifier of the ownerownerType - is the owner identifier a user id, personal profile or team profilezoneMembership - governance zones for the database - null means use the default zones set for this serviceorigin - the properties that characterize where this database is fromlatestChange - latest change string for the databasecreateTime - the time that the database was createdmodifiedTime - the last known time the data store was modifiedencodingType - the name of the encoding style used in the databaseencodingLanguage - the name of the natural language used for text strings within the databaseencodingDescription - the description of the encoding used in the databasedatabaseType - a description of the database typedatabaseVersion - the version of the database - often this is related to the version of its schemas.databaseInstance - the name of this database instance - useful if the same schemas are deployed to multiple database instancesdatabaseImportedFrom - the source (typically connection name) of the database informationadditionalProperties - any arbitrary properties not part of the type systemtypeName - name of the type that is a subtype of Database - or null to create standard typeextendedProperties - properties from any subtypemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void publishDatabase(String userId, String integratorGUID, String integratorName, String databaseGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseGUID - unique identifier of the metadata element to publishmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void withdrawDatabase(String userId, String integratorGUID, String integratorName, String databaseGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseGUID - unique identifier of the metadata element to withdrawmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void removeDatabase(String userId, String integratorGUID, String integratorName, String databaseGUID, String qualifiedName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<Asset> findDatabases(String userId, String searchString, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<Asset> getDatabasesByName(String userId, String name, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<Asset> getDatabasesByDaemon(String userId, String integratorGUID, String integratorName, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public Asset getDatabaseByGUID(String userId, String guid, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userguid - unique identifier of the requested metadata elementmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public String createDatabaseSchema(String userId, String integratorGUID, String integratorName, String databaseGUID, String qualifiedName, String displayName, String description, String owner, OwnerType ownerType, List<String> zoneMembership, Map<String,String> origin, String latestChange, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseGUID - unique identifier of the database where the schema is locatedqualifiedName - unique name for this database schemadisplayName - the stored display name property for the database schemadescription - the stored description property associated with the database schemaowner - identifier of the ownerownerType - is the owner identifier a user id, personal profile or team profilezoneMembership - governance zones for the database schema - null means use the default zones set for this serviceorigin - the properties that characterize where this database schema is fromlatestChange - latest change string for the database schemaadditionalProperties - any arbitrary properties not part of the type systemtypeName - name of the type that is a subtype of DeployedDatabaseSchema - or null to create standard typeextendedProperties - properties from any subtypemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public String createDatabaseSchemaFromTemplate(String userId, String integratorGUID, String integratorName, String templateGUID, String databaseGUID, String qualifiedName, String displayName, String description, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callertemplateGUID - unique identifier of the metadata element to copydatabaseGUID - unique identifier of the database where the schema is locatedqualifiedName - unique name for the database schemadisplayName - the stored display name property for the database schemadescription - the stored description property associated with the database schemamethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void updateDatabaseSchema(String userId, String integratorGUID, String integratorName, String databaseSchemaGUID, String qualifiedName, String displayName, String description, String owner, OwnerType ownerType, List<String> zoneMembership, Map<String,String> origin, String latestChange, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseSchemaGUID - unique identifier of the metadata element to updatequalifiedName - unique name for the database schemadisplayName - the stored display name property for the database schemadescription - the stored description property associated with the database schemaowner - identifier of the ownerownerType - is the owner identifier a user id, personal profile or team profilezoneMembership - governance zones for the database schema - null means use the default zones set for this serviceorigin - the properties that characterize where this database schema is fromlatestChange - latest change string for the database schemaadditionalProperties - any arbitrary properties not part of the type systemtypeName - name of the type that is a subtype of DeployedDatabaseSchema - or null to create standard typeextendedProperties - properties from any subtypemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void publishDatabaseSchema(String userId, String integratorGUID, String integratorName, String databaseSchemaGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseSchemaGUID - unique identifier of the metadata element to publishmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void withdrawDatabaseSchema(String userId, String integratorGUID, String integratorName, String databaseSchemaGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseSchemaGUID - unique identifier of the metadata element to withdrawmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void removeDatabaseSchema(String userId, String integratorGUID, String integratorName, String databaseSchemaGUID, String qualifiedName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseSchemaGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<Asset> findDatabaseSchemas(String userId, String searchString, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<Asset> getSchemasForDatabase(String userId, String databaseGUID, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseGUID - unique identifier of the database to querystartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<Asset> getDatabaseSchemasByName(String userId, String name, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public Asset getDatabaseSchemaByGUID(String userId, String guid, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userguid - unique identifier of the requested metadata elementmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public String createDatabaseTable(String userId, String integratorGUID, String integratorName, String databaseSchemaGUID, String qualifiedName, String displayName, String description, boolean isDeprecated, List<String> aliases, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseSchemaGUID - unique identifier of the database schema where the database table is locatedqualifiedName - unique name for the database schemadisplayName - the stored display name property for the database tabledescription - the stored description property associated with the database tableisDeprecated - is this table deprecated?aliases - a list of alternative names for the attributeadditionalProperties - any arbitrary properties not part of the type systemtypeName - name of the type that is a subtype of DeployedDatabaseSchema - or null to create standard typeextendedProperties - properties from any subtypemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public String createDatabaseTableFromTemplate(String userId, String integratorGUID, String integratorName, String templateGUID, String databaseSchemaGUID, String qualifiedName, String displayName, String description, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callertemplateGUID - unique identifier of the metadata element to copydatabaseSchemaGUID - unique identifier of the database schema where the database table is located.qualifiedName - unique name for the database schemadisplayName - the stored display name property for the database tabledescription - the stored description property associated with the database tablemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void updateDatabaseTable(String userId, String integratorGUID, String integratorName, String databaseTableGUID, String qualifiedName, String displayName, String description, boolean isDeprecated, List<String> aliases, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseTableGUID - unique identifier of the database table to updatequalifiedName - unique name for the database schemadisplayName - the stored display name property for the database tabledescription - the stored description property associated with the database tableisDeprecated - is this table deprecated?aliases - a list of alternative names for the attributeadditionalProperties - any arbitrary properties not part of the type systemtypeName - name of the type that is a subtype of DeployedDatabaseSchema - or null to create standard typeextendedProperties - properties from any subtypemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void removeDatabaseTable(String userId, String integratorGUID, String integratorName, String databaseTableGUID, String qualifiedName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseTableGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<SchemaAttribute> findDatabaseTables(String userId, String searchString, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<SchemaAttribute> getTablesForDatabaseSchema(String userId, String databaseSchemaGUID, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseSchemaGUID - unique identifier of the database schema of intereststartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<SchemaAttribute> getDatabaseTablesByName(String userId, String name, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public SchemaAttribute getDatabaseTableByGUID(String userId, String guid, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userguid - unique identifier of the requested metadata elementmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public String createDatabaseView(String userId, String integratorGUID, String integratorName, String databaseSchemaGUID, String qualifiedName, String displayName, String description, boolean isDeprecated, List<String> aliases, String expression, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseSchemaGUID - unique identifier of the database schema where the database view is located.qualifiedName - unique name for the database schemadisplayName - the stored display name property for the database tabledescription - the stored description property associated with the database tableisDeprecated - is this table deprecated?aliases - a list of alternative names for the attributeexpression - the code that generates the value for this view.additionalProperties - any arbitrary properties not part of the type systemtypeName - name of the type that is a subtype of DeployedDatabaseSchema - or null to create standard typeextendedProperties - properties from any subtypemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public String createDatabaseViewFromTemplate(String userId, String integratorGUID, String integratorName, String templateGUID, String databaseSchemaGUID, String qualifiedName, String displayName, String description, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callertemplateGUID - unique identifier of the metadata element to copydatabaseSchemaGUID - unique identifier of the database schema where the database view is located.qualifiedName - unique name for the database schemadisplayName - the stored display name property for the database tabledescription - the stored description property associated with the database tablemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void updateDatabaseView(String userId, String integratorGUID, String integratorName, String databaseViewGUID, String qualifiedName, String displayName, String description, boolean isDeprecated, List<String> aliases, String expression, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseViewGUID - unique identifier of the database view to updatequalifiedName - unique name for the database schemadisplayName - the stored display name property for the database tabledescription - the stored description property associated with the database tableisDeprecated - is this table deprecated?aliases - a list of alternative names for the attributeexpression - the code that generates the value for this view.additionalProperties - any arbitrary properties not part of the type systemtypeName - name of the type that is a subtype of DeployedDatabaseSchema - or null to create standard typeextendedProperties - properties from any subtypemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void removeDatabaseView(String userId, String integratorGUID, String integratorName, String databaseViewGUID, String qualifiedName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseViewGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<SchemaAttribute> findDatabaseViews(String userId, String searchString, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<SchemaAttribute> getViewsForDatabaseSchema(String userId, String databaseSchemaGUID, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseSchemaGUID - unique identifier of the database schema of intereststartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<SchemaAttribute> getDatabaseViewsByName(String userId, String name, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public SchemaAttribute getDatabaseViewByGUID(String userId, String guid, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userguid - unique identifier of the requested metadata elementmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public String createDatabaseColumn(String userId, String integratorGUID, String integratorName, String databaseTableGUID, String qualifiedName, String displayName, String description, String dataType, String defaultValue, String formula, List<SchemaImplementationQuery> queries, boolean isDeprecated, int elementPosition, int minCardinality, int maxCardinality, boolean allowsDuplicateValues, boolean orderedValues, String defaultValueOverride, DataItemSortOrder sortOrder, int minimumLength, int length, int significantDigits, boolean isNullable, String nativeJavaClass, List<String> aliases, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseTableGUID - unique identifier of the database table where this column is locatedqualifiedName - unique name for the database schemadisplayName - the stored display name property for the database tabledescription - the stored description property associated with the database tabledataType - data type name - for stored valuesdefaultValue - string containing default value - for stored valuesformula - String formula - for derived valuesqueries - list of queries and their target elementisDeprecated - is this table deprecated?elementPosition - the position of this column in its parent table.minCardinality - minimum number of repeating instances allowed for this column - typically 1maxCardinality - the maximum number of repeating instances allowed for this column - typically 1allowsDuplicateValues - whether the same value can be used by more than one instance of this attributeorderedValues - whether the attribute instances are arranged in an ordersortOrder - the order that the attribute instances are arranged in - if anyminimumLength - the minimum length of the datalength - the length of the data fieldsignificantDigits - number of significant digits to the right of decimal pointisNullable - whether the field is nullable or notnativeJavaClass - equivalent Java class implementationdefaultValueOverride - default value for this columnaliases - a list of alternative names for the attributeadditionalProperties - any arbitrary properties not part of the type systemtypeName - name of the type that is a subtype of DeployedDatabaseSchema - or null to create standard typeextendedProperties - properties from any subtypemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public String createDatabaseColumnFromTemplate(String userId, String integratorGUID, String integratorName, String templateGUID, String databaseTableGUID, String qualifiedName, String displayName, String description, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callertemplateGUID - unique identifier of the metadata element to copydatabaseTableGUID - unique identifier of the database table where this column is locatedqualifiedName - unique name for the database schemadisplayName - the stored display name property for the database tabledescription - the stored description property associated with the database tablemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void updateDatabaseColumn(String userId, String integratorGUID, String integratorName, String databaseColumnGUID, String qualifiedName, String displayName, String description, String dataType, String defaultValue, String formula, List<SchemaImplementationQuery> queries, boolean isDeprecated, int elementPosition, int minCardinality, int maxCardinality, boolean allowsDuplicateValues, boolean orderedValues, String defaultValueOverride, DataItemSortOrder sortOrder, int minimumLength, int length, int significantDigits, boolean isNullable, String nativeJavaClass, List<String> aliases, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseColumnGUID - unique identifier of the metadata element to updatequalifiedName - unique name for the database schemadisplayName - the stored display name property for the database tabledescription - the stored description property associated with the database tabledataType - data type name - for stored valuesdefaultValue - string containing default value - for stored valuesformula - String formula - for derived valuesqueries - list of queries and their target elementisDeprecated - is this table deprecated?elementPosition - the position of this column in its parent table.minCardinality - minimum number of repeating instances allowed for this column - typically 1maxCardinality - the maximum number of repeating instances allowed for this column - typically 1allowsDuplicateValues - whether the same value can be used by more than one instance of this attributeorderedValues - whether the attribute instances are arranged in an ordersortOrder - the order that the attribute instances are arranged in - if anyminimumLength - the minimum length of the datalength - the length of the data fieldsignificantDigits - number of significant digits to the right of decimal pointisNullable - whether the field is nullable or notnativeJavaClass - equivalent Java class implementationdefaultValueOverride - default value for this columnaliases - a list of alternative names for the attributeadditionalProperties - any arbitrary properties not part of the type systemtypeName - name of the type that is a subtype of DeployedDatabaseSchema - or null to create standard typeextendedProperties - properties from any subtypemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void updateDatabaseDerivedColumn(String userId, String integratorGUID, String integratorName, String databaseColumnGUID, String qualifiedName, String displayName, String description, boolean isDeprecated, int elementPosition, int minCardinality, int maxCardinality, boolean allowsDuplicateValues, boolean orderedValues, String defaultValueOverride, DataItemSortOrder sortOrder, int minimumLength, int length, int significantDigits, boolean isNullable, String nativeJavaClass, List<String> aliases, String expression, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseColumnGUID - unique identifier of the metadata element to updatequalifiedName - unique name for the database schemadisplayName - the stored display name property for the database tabledescription - the stored description property associated with the database tableisDeprecated - is this table deprecated?elementPosition - the position of this column in its parent table.minCardinality - minimum number of repeating instances allowed for this column - typically 1maxCardinality - the maximum number of repeating instances allowed for this column - typically 1allowsDuplicateValues - whether the same value can be used by more than one instance of this attributeorderedValues - whether the attribute instances are arranged in an ordersortOrder - the order that the attribute instances are arranged in - if anyminimumLength - the minimum length of the datalength - the length of the data fieldsignificantDigits - number of significant digits to the right of decimal pointisNullable - whether the field is nullable or notnativeJavaClass - equivalent Java class implementationdefaultValueOverride - default value for this columnaliases - a list of alternative names for the attributeexpression - the code that generates the value for this view.additionalProperties - any arbitrary properties not part of the type systemtypeName - name of the type that is a subtype of DeployedDatabaseSchema - or null to create standard typeextendedProperties - properties from any subtypemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void removeDatabaseColumn(String userId, String integratorGUID, String integratorName, String databaseColumnGUID, String qualifiedName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseColumnGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<SchemaAttribute> findDatabaseColumns(String userId, String searchString, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<SchemaAttribute> getColumnsForDatabaseTable(String userId, String databaseTableGUID, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseTableGUID - unique identifier of the database table of intereststartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<SchemaAttribute> getDatabaseColumnsByName(String userId, String name, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public SchemaAttribute getDatabaseColumnByGUID(String userId, String guid, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userguid - unique identifier of the requested metadata elementmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void setPrimaryKeyOnColumn(String userId, String integratorGUID, String integratorName, String databaseColumnGUID, String name, KeyPattern keyPattern, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseColumnGUID - unique identifier if the primary key columnname - name of primary keykeyPattern - type of lifecycle and scopemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void removePrimaryKeyFromColumn(String userId, String integratorGUID, String integratorName, String databaseColumnGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerdatabaseColumnGUID - unique identifier if the primary key columnmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void addForeignKeyRelationship(String userId, String integratorGUID, String integratorName, String primaryKeyColumnGUID, String foreignKeyColumnGUID, String name, String description, int confidence, String steward, String source, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerprimaryKeyColumnGUID - unique identifier of the column containing the primary keyforeignKeyColumnGUID - unique identifier of the column containing the primary key from the other tablename - the display name for UIs and reportsdescription - description of the foreign keyconfidence - the level of confidence that the foreign key is correct. This is a value between 0 and 100steward - the name of the steward who assigned the foreign key (or approved the discovered value)source - the id of the source of the knowledge of the foreign keymethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void removeForeignKeyRelationship(String userId, String integratorGUID, String integratorName, String primaryKeyColumnGUID, String foreignKeyColumnGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userintegratorGUID - unique identifier of software server capability representing the callerintegratorName - unique name of software server capability representing the callerprimaryKeyColumnGUID - unique identifier of the column that is the linked primary keyforeignKeyColumnGUID - unique identifier of the column the contains the primary key from another tablemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)Copyright © 2018–2020 ODPi. All rights reserved.