public class RelationalDataHandler<DATABASE,DATABASE_SCHEMA,DATABASE_TABLE,DATABASE_VIEW,DATABASE_COLUMN,SCHEMA_TYPE> extends Object
| Modifier and Type | Field and Description |
|---|---|
protected RepositoryErrorHandler |
errorHandler |
| Constructor and Description |
|---|
RelationalDataHandler(OpenMetadataAPIGenericConverter<DATABASE> databaseConverter,
Class<DATABASE> databaseClass,
OpenMetadataAPIGenericConverter<DATABASE_SCHEMA> databaseSchemaConverter,
Class<DATABASE_SCHEMA> databaseSchemaClass,
OpenMetadataAPIGenericConverter<DATABASE_TABLE> databaseTableConverter,
Class<DATABASE_TABLE> databaseTableClass,
OpenMetadataAPIGenericConverter<DATABASE_VIEW> databaseViewConverter,
Class<DATABASE_VIEW> databaseViewClass,
OpenMetadataAPIGenericConverter<DATABASE_COLUMN> databaseColumnConverter,
Class<DATABASE_COLUMN> databaseColumnClass,
OpenMetadataAPIGenericConverter<SCHEMA_TYPE> schemaTypeConverter,
Class<SCHEMA_TYPE> schemaTypeClass,
String serviceName,
String serverName,
InvalidParameterHandler invalidParameterHandler,
RepositoryHandler repositoryHandler,
OMRSRepositoryHelper repositoryHelper,
String localServerUserId,
OpenMetadataServerSecurityVerifier securityVerifier,
List<String> supportedZones,
List<String> defaultZones,
List<String> publishZones,
AuditLog auditLog)
Construct the relational data handler with information needed to work with assets and schemas.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addForeignKeyRelationship(String userId,
String databaseManagerGUID,
String databaseManagerName,
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 databaseManagerGUID,
String databaseManagerName,
String qualifiedName,
String displayName,
String description,
String owner,
int ownerTypeOrdinal,
List<String> zoneMembership,
String originOrganizationGUID,
String originBusinessCapabilityGUID,
Map<String,String> otherOriginValues,
String pathName,
Date createTime,
Date modifiedTime,
String encodingType,
String encodingLanguage,
String encodingDescription,
Map<String,String> encodingProperties,
String databaseType,
String databaseVersion,
String databaseInstance,
String databaseImportedFrom,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
Map<String,String> vendorProperties,
String methodName)
Create a new metadata element to represent a database that is owned by an external element.
|
String |
createDatabaseColumn(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseTableGUID,
String qualifiedName,
String displayName,
String description,
String externalSchemaTypeGUID,
String dataType,
String defaultValue,
String fixedValue,
String validValuesSetGUID,
String formula,
boolean isDeprecated,
int elementPosition,
int minCardinality,
int maxCardinality,
boolean allowsDuplicateValues,
boolean orderedValues,
String defaultValueOverride,
int sortOrder,
int minimumLength,
int length,
int significantDigits,
boolean isNullable,
String nativeJavaClass,
List<String> aliases,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
Map<String,String> vendorProperties,
String methodName)
Create a new metadata element to represent a database column.
|
String |
createDatabaseColumnFromTemplate(String userId,
String databaseManagerGUID,
String databaseManagerName,
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.
|
void |
createDatabaseColumnQuery(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseColumnGUID,
String queryId,
String query,
String queryTargetGUID,
String methodName)
Create a new query relationship for a derived database column.
|
String |
createDatabaseFromTemplate(String userId,
String databaseManagerGUID,
String databaseManagerName,
String templateGUID,
String qualifiedName,
String displayName,
String description,
String networkAddress,
String methodName)
Create a new metadata element to represent a database using an existing metadata element as a template.
|
String |
createDatabaseSchema(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseGUID,
String qualifiedName,
String displayName,
String description,
String owner,
int ownerTypeOrdinal,
List<String> zoneMembership,
String originOrganizationGUID,
String originBusinessCapabilityGUID,
Map<String,String> otherOriginValues,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
Map<String,String> vendorProperties,
String methodName)
Create a new metadata element to represent a database schema.
|
String |
createDatabaseSchemaFromTemplate(String userId,
String databaseManagerGUID,
String databaseManagerName,
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 databaseManagerGUID,
String databaseManagerName,
String databaseSchemaGUID,
String qualifiedName,
String displayName,
String description,
boolean isDeprecated,
List<String> aliases,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
Map<String,String> vendorProperties,
String methodName)
Create a new metadata element to represent a database table.
|
String |
createDatabaseTableFromTemplate(String userId,
String databaseManagerGUID,
String databaseManagerName,
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 databaseManagerGUID,
String databaseManagerName,
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,
Map<String,String> vendorProperties,
String methodName)
Create a new metadata element to represent a database view.
|
String |
createDatabaseViewFromTemplate(String userId,
String databaseManagerGUID,
String databaseManagerName,
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<DATABASE_COLUMN> |
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<DATABASE> |
findDatabases(String userId,
String searchString,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database metadata elements that contain the search string.
|
List<DATABASE_SCHEMA> |
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<DATABASE_TABLE> |
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<DATABASE_VIEW> |
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<DATABASE_COLUMN> |
getColumnsForDatabaseTable(String userId,
String databaseTableGUID,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of column for a database table (or view)
|
DATABASE |
getDatabaseByGUID(String userId,
String guid,
String methodName)
Retrieve the database metadata element with the supplied unique identifier.
|
DATABASE_COLUMN |
getDatabaseColumnByGUID(String userId,
String guid,
String methodName)
Retrieve the database column metadata element with the supplied unique identifier.
|
List<DATABASE_COLUMN> |
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<DATABASE> |
getDatabases(String userId,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database metadata elements.
|
List<DATABASE> |
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.
|
DATABASE_SCHEMA |
getDatabaseSchemaByGUID(String userId,
String guid,
String methodName)
Retrieve the database schema metadata element with the supplied unique identifier.
|
List<DATABASE_SCHEMA> |
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.
|
List<DATABASE> |
getDatabasesForDatabaseManager(String userId,
String databaseManagerGUID,
String databaseManagerName,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of databases created for the requested database manager.
|
DATABASE_TABLE |
getDatabaseTableByGUID(String userId,
String guid,
String methodName)
Retrieve the database table metadata element with the supplied unique identifier.
|
List<DATABASE_TABLE> |
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.
|
DATABASE_VIEW |
getDatabaseViewByGUID(String userId,
String guid,
String methodName)
Retrieve the database view metadata element with the supplied unique identifier.
|
List<DATABASE_VIEW> |
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<DATABASE_SCHEMA> |
getSchemasForDatabase(String userId,
String databaseGUID,
int startFrom,
int pageSize,
String methodName)
Return the list of (deployed database) schemas associated with a database.
|
List<DATABASE_TABLE> |
getTablesForDatabaseSchema(String userId,
String databaseSchemaGUID,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of database tables associated with a database schema.
|
List<DATABASE_VIEW> |
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 databaseGUID,
String methodName)
Update the zones for the database asset so that it becomes visible to consumers.
|
void |
publishDatabaseSchema(String userId,
String databaseSchemaGUID,
String methodName)
Update the zones for the database asset so that it becomes visible to consumers.
|
void |
removeDatabase(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseGUID,
String qualifiedName,
String methodName)
Remove the metadata element representing a database.
|
void |
removeDatabaseColumn(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseColumnGUID,
String qualifiedName,
String methodName)
Remove the metadata element representing a database column.
|
void |
removeDatabaseSchema(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseSchemaGUID,
String qualifiedName,
String methodName)
Remove the metadata element representing a database schema.
|
void |
removeDatabaseTable(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseTableGUID,
String databaseTableGUIDParameterName,
String qualifiedName,
String methodName)
Remove the metadata element representing a database table.
|
void |
removeForeignKeyRelationship(String userId,
String databaseManagerGUID,
String databaseManagerName,
String primaryKeyColumnGUID,
String foreignKeyColumnGUID,
String methodName)
Remove the foreign key relationship for the requested columns.
|
void |
removePrimaryKeyFromColumn(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseColumnGUID,
String methodName)
Remove the classification that this column is a primary key.
|
void |
setPrimaryKeyOnColumn(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseColumnGUID,
String name,
int keyPatternOrdinal,
String methodName)
Classify a column in a database table as the primary key.
|
void |
updateDatabase(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseGUID,
String qualifiedName,
String displayName,
String description,
String owner,
int ownerTypeOrdinal,
List<String> zoneMembership,
String originOrganizationGUID,
String originBusinessCapabilityGUID,
Map<String,String> otherOriginValues,
Date createTime,
Date modifiedTime,
String encodingType,
String encodingLanguage,
String encodingDescription,
Map<String,String> encodingProperties,
String databaseType,
String databaseVersion,
String databaseInstance,
String databaseImportedFrom,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
Map<String,String> vendorProperties,
String methodName)
Update the metadata element representing a database.
|
void |
updateDatabaseColumn(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseColumnGUID,
String qualifiedName,
String displayName,
String description,
String dataType,
String defaultValue,
String fixedValue,
String formula,
boolean isDeprecated,
int elementPosition,
int minCardinality,
int maxCardinality,
boolean allowsDuplicateValues,
boolean orderedValues,
String defaultValueOverride,
int sortOrder,
int minimumLength,
int length,
int significantDigits,
boolean isNullable,
String nativeJavaClass,
List<String> aliases,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
Map<String,String> vendorProperties,
String methodName)
Update the metadata element representing a database column.
|
void |
updateDatabaseSchema(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseSchemaGUID,
String qualifiedName,
String displayName,
String description,
String owner,
int ownerTypeOrdinal,
List<String> zoneMembership,
String originOrganizationGUID,
String originBusinessCapabilityGUID,
Map<String,String> otherOriginValues,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
Map<String,String> vendorProperties,
String methodName)
Update the metadata element representing a database schema.
|
void |
updateDatabaseTable(String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseTableGUID,
String qualifiedName,
String displayName,
String description,
boolean isDeprecated,
List<String> aliases,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
Map<String,String> vendorProperties,
String methodName)
Update the metadata element representing a database table.
|
void |
updateDatabaseView(String userId,
String databaseManagerGUID,
String databaseManagerName,
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,
Map<String,String> vendorProperties,
String methodName)
Update the metadata element representing a database table.
|
void |
withdrawDatabase(String userId,
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 databaseSchemaGUID,
String methodName)
Update the zones for the database asset so that it is no longer visible to consumers.
|
protected RepositoryErrorHandler errorHandler
public RelationalDataHandler(OpenMetadataAPIGenericConverter<DATABASE> databaseConverter, Class<DATABASE> databaseClass, OpenMetadataAPIGenericConverter<DATABASE_SCHEMA> databaseSchemaConverter, Class<DATABASE_SCHEMA> databaseSchemaClass, OpenMetadataAPIGenericConverter<DATABASE_TABLE> databaseTableConverter, Class<DATABASE_TABLE> databaseTableClass, OpenMetadataAPIGenericConverter<DATABASE_VIEW> databaseViewConverter, Class<DATABASE_VIEW> databaseViewClass, OpenMetadataAPIGenericConverter<DATABASE_COLUMN> databaseColumnConverter, Class<DATABASE_COLUMN> databaseColumnClass, OpenMetadataAPIGenericConverter<SCHEMA_TYPE> schemaTypeConverter, Class<SCHEMA_TYPE> schemaTypeClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)
databaseConverter - specific converter for the DATABASE bean classdatabaseClass - name of bean class that is represented by the generic class DATABASEdatabaseSchemaConverter - specific converter for the DATABASE_SCHEMA bean classdatabaseSchemaClass - name of bean class that is represented by the generic class DATABASE_SCHEMAdatabaseTableConverter - specific converter for the DATABASE_TABLE bean classdatabaseTableClass - name of bean class that is represented by the generic class DATABASE_TABLEdatabaseViewConverter - specific converter for the DATABASE_VIEW bean classdatabaseViewClass - name of bean class that is represented by the generic class DATABASE_VIEWdatabaseColumnConverter - specific converter for the DATABASE_COLUMN bean classdatabaseColumnClass - name of bean class that is represented by the generic class DATABASE_COLUMNschemaTypeConverter - specific converter for the SCHEMA_TYPE bean classschemaTypeClass - name of bean class that is represented by the generic class SCHEMA_TYPEserviceName - name of this serviceserverName - name of the local serverinvalidParameterHandler - handler for managing parameter errorsrepositoryHandler - manages calls to the repository servicesrepositoryHelper - provides utilities for manipulating the repository services objectslocalServerUserId - userId for this serversecurityVerifier - open metadata security services verifiersupportedZones - list of zones that the access service is allowed to serve Asset instances from.defaultZones - list of zones that the access service should set in all new Asset instances.publishZones - list of zones that the access service sets up in published Asset instances.auditLog - destination for audit log events.public String createDatabase(String userId, String databaseManagerGUID, String databaseManagerName, String qualifiedName, String displayName, String description, String owner, int ownerTypeOrdinal, List<String> zoneMembership, String originOrganizationGUID, String originBusinessCapabilityGUID, Map<String,String> otherOriginValues, String pathName, Date createTime, Date modifiedTime, String encodingType, String encodingLanguage, String encodingDescription, Map<String,String> encodingProperties, String databaseType, String databaseVersion, String databaseInstance, String databaseImportedFrom, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSqualifiedName - unique name for this databasedisplayName - the stored display name property for the databasedescription - the stored description property associated with the databaseowner - identifier of the ownerownerTypeOrdinal - 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 serviceoriginOrganizationGUID - the properties that characterize where this database is fromoriginBusinessCapabilityGUID - the properties that characterize where this database is fromotherOriginValues - the properties that characterize where this database is frompathName - the fully qualified physical location of the data storecreateTime - 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 databaseencodingProperties - properties used to control encodingdatabaseType - 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 subtypevendorProperties - additional properties relating to the source of the database technologymethodName - 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 databaseManagerGUID, String databaseManagerName, String templateGUID, String qualifiedName, String displayName, String description, String networkAddress, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMStemplateGUID - 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 usednetworkAddress - physical location of the database - used to connect to itmethodName - 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 databaseManagerGUID, String databaseManagerName, String databaseGUID, String qualifiedName, String displayName, String description, String owner, int ownerTypeOrdinal, List<String> zoneMembership, String originOrganizationGUID, String originBusinessCapabilityGUID, Map<String,String> otherOriginValues, Date createTime, Date modifiedTime, String encodingType, String encodingLanguage, String encodingDescription, Map<String,String> encodingProperties, String databaseType, String databaseVersion, String databaseInstance, String databaseImportedFrom, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseGUID - 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 ownerownerTypeOrdinal - 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 serviceoriginOrganizationGUID - the properties that characterize where this database is fromoriginBusinessCapabilityGUID - the properties that characterize where this database is fromotherOriginValues - the properties that characterize where this database is fromcreateTime - 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 databaseencodingProperties - properties used to control encodingdatabaseType - 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 subtypevendorProperties - additional properties relating to the source of the database technologymethodName - 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 databaseGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseGUID - 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 databaseGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseGUID - 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 databaseManagerGUID, String databaseManagerName, String databaseGUID, String qualifiedName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseGUID - 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<DATABASE> 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<DATABASE> getDatabases(String userId, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userstartFrom - 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<DATABASE> 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<DATABASE> getDatabasesForDatabaseManager(String userId, String databaseManagerGUID, String databaseManagerName, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSstartFrom - 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 DATABASE 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 databaseManagerGUID, String databaseManagerName, String databaseGUID, String qualifiedName, String displayName, String description, String owner, int ownerTypeOrdinal, List<String> zoneMembership, String originOrganizationGUID, String originBusinessCapabilityGUID, Map<String,String> otherOriginValues, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseGUID - 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 ownerownerTypeOrdinal - 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 serviceoriginOrganizationGUID - the properties that characterize where this database schema is fromoriginBusinessCapabilityGUID - the properties that characterize where this database schema is fromotherOriginValues - the properties that characterize where this database schema is fromadditionalProperties - 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 subtypevendorProperties - additional properties relating to the source of the database technologymethodName - 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 databaseManagerGUID, String databaseManagerName, String templateGUID, String databaseGUID, String qualifiedName, String displayName, String description, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMStemplateGUID - 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 databaseManagerGUID, String databaseManagerName, String databaseSchemaGUID, String qualifiedName, String displayName, String description, String owner, int ownerTypeOrdinal, List<String> zoneMembership, String originOrganizationGUID, String originBusinessCapabilityGUID, Map<String,String> otherOriginValues, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseSchemaGUID - 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 ownerownerTypeOrdinal - 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 serviceoriginOrganizationGUID - the properties that characterize where this database schema is fromoriginBusinessCapabilityGUID - the properties that characterize where this database schema is fromotherOriginValues - the properties that characterize where this database schema is fromadditionalProperties - 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 subtypevendorProperties - additional properties relating to the source of the database technologymethodName - 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 databaseSchemaGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseSchemaGUID - 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 databaseSchemaGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseSchemaGUID - 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 databaseManagerGUID, String databaseManagerName, String databaseSchemaGUID, String qualifiedName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseSchemaGUID - 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<DATABASE_SCHEMA> 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<DATABASE_SCHEMA> 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<DATABASE_SCHEMA> 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 DATABASE_SCHEMA 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 databaseManagerGUID, String databaseManagerName, String databaseSchemaGUID, String qualifiedName, String displayName, String description, boolean isDeprecated, List<String> aliases, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseSchemaGUID - unique identifier of the database schema where the database table is locatedqualifiedName - unique name for the database tabledisplayName - 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 RelationalTable - or null to create standard typeextendedProperties - properties from any subtypevendorProperties - additional properties relating to the source of the database technologymethodName - 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 databaseManagerGUID, String databaseManagerName, String templateGUID, String databaseSchemaGUID, String qualifiedName, String displayName, String description, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMS - if null a local element is createddatabaseManagerName - unique name of software server capability representing the DBMStemplateGUID - 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 databaseManagerGUID, String databaseManagerName, String databaseTableGUID, String qualifiedName, String displayName, String description, boolean isDeprecated, List<String> aliases, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseTableGUID - 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 subtypevendorProperties - additional properties relating to the source of the database technologymethodName - 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 databaseManagerGUID, String databaseManagerName, String databaseTableGUID, String databaseTableGUIDParameterName, String qualifiedName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseTableGUID - unique identifier of the metadata element to removedatabaseTableGUIDParameterName - name of parameter supplying databaseTableGUIDqualifiedName - 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<DATABASE_TABLE> 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<DATABASE_TABLE> 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<DATABASE_TABLE> 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 DATABASE_TABLE 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 databaseManagerGUID, String databaseManagerName, 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, Map<String,String> vendorProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseSchemaGUID - 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 subtypevendorProperties - additional properties relating to the source of the database technologymethodName - 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 databaseManagerGUID, String databaseManagerName, String templateGUID, String databaseSchemaGUID, String qualifiedName, String displayName, String description, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMStemplateGUID - 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 databaseManagerGUID, String databaseManagerName, 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, Map<String,String> vendorProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseViewGUID - 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 subtypevendorProperties - additional properties relating to the source of the database technologymethodName - 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<DATABASE_VIEW> 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<DATABASE_VIEW> 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<DATABASE_VIEW> 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 DATABASE_VIEW 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 databaseManagerGUID, String databaseManagerName, String databaseTableGUID, String qualifiedName, String displayName, String description, String externalSchemaTypeGUID, String dataType, String defaultValue, String fixedValue, String validValuesSetGUID, String formula, boolean isDeprecated, int elementPosition, int minCardinality, int maxCardinality, boolean allowsDuplicateValues, boolean orderedValues, String defaultValueOverride, int sortOrder, int minimumLength, int length, int significantDigits, boolean isNullable, String nativeJavaClass, List<String> aliases, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseTableGUID - 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 tableexternalSchemaTypeGUID - unique identifier of a schema Type that provides the type. If null, a private schema type is useddataType - data type name - for stored valuesdefaultValue - string containing default value - for stored valuesfixedValue - string containing a fixed value - for a literalvalidValuesSetGUID - unique identifier of a valid value set that lists the valid values for this schemaformula - String formula - for derived valuesisDeprecated - 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 subtypevendorProperties - additional properties relating to the source of the database technologymethodName - 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 createDatabaseColumnQuery(String userId, String databaseManagerGUID, String databaseManagerName, String databaseColumnGUID, String queryId, String query, String queryTargetGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseColumnGUID - unique identifier of the database column that this query supportsqueryId - identifier for the query - used as a placeholder in the formula (stored in the column's CalculatedValue classification)query - the query that is made on the targetGUIDqueryTargetGUID - the unique identifier of the target (this is a schema element - typically a column)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 String createDatabaseColumnFromTemplate(String userId, String databaseManagerGUID, String databaseManagerName, String templateGUID, String databaseTableGUID, String qualifiedName, String displayName, String description, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMStemplateGUID - 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 databaseManagerGUID, String databaseManagerName, String databaseColumnGUID, String qualifiedName, String displayName, String description, String dataType, String defaultValue, String fixedValue, String formula, boolean isDeprecated, int elementPosition, int minCardinality, int maxCardinality, boolean allowsDuplicateValues, boolean orderedValues, String defaultValueOverride, int sortOrder, int minimumLength, int length, int significantDigits, boolean isNullable, String nativeJavaClass, List<String> aliases, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseColumnGUID - 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 valuesfixedValue - string containing fixed value - for literalsformula - String formula - for derived valuesisDeprecated - 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 subtypevendorProperties - additional properties relating to the source of the database technologymethodName - 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 databaseManagerGUID, String databaseManagerName, String databaseColumnGUID, String qualifiedName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseColumnGUID - 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<DATABASE_COLUMN> 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<DATABASE_COLUMN> 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<DATABASE_COLUMN> 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 DATABASE_COLUMN 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 databaseManagerGUID, String databaseManagerName, String databaseColumnGUID, String name, int keyPatternOrdinal, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseColumnGUID - unique identifier if the primary key columnname - name of primary keykeyPatternOrdinal - 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 databaseManagerGUID, String databaseManagerName, String databaseColumnGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSdatabaseColumnGUID - 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 databaseManagerGUID, String databaseManagerName, String primaryKeyColumnGUID, String foreignKeyColumnGUID, String name, String description, int confidence, String steward, String source, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSprimaryKeyColumnGUID - 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 databaseManagerGUID, String databaseManagerName, String primaryKeyColumnGUID, String foreignKeyColumnGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the DBMSdatabaseManagerName - unique name of software server capability representing the DBMSprimaryKeyColumnGUID - 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–2021 LF AI & Data Foundation. All rights reserved.