Package org.openmetadata.service.jdbi3
Class DashboardDataModelRepository
- java.lang.Object
-
- org.openmetadata.service.jdbi3.EntityRepository<DashboardDataModel>
-
- org.openmetadata.service.jdbi3.DashboardDataModelRepository
-
public class DashboardDataModelRepository extends EntityRepository<DashboardDataModel>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classDashboardDataModelRepository.DataModelUpdater-
Nested classes/interfaces inherited from class org.openmetadata.service.jdbi3.EntityRepository
EntityRepository.EntityUpdater, EntityRepository.Operation
-
-
Field Summary
-
Fields inherited from class org.openmetadata.service.jdbi3.EntityRepository
allowedFields, CACHE_WITH_ID, CACHE_WITH_NAME, dao, daoCollection, entityType, putFields, quoteFqn, supportsExtension, supportsFollower, supportsOwner, supportsSoftDelete, supportsTags, supportsVotes
-
-
Constructor Summary
Constructors Constructor Description DashboardDataModelRepository(CollectionDAO dao)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidapplyTags(DashboardDataModel dashboardDataModel)DashboardDataModelclearFields(DashboardDataModel dashboardDataModel, EntityUtil.Fields fields)Set the requested fields in an entity.EntityRepository.EntityUpdatergetUpdater(DashboardDataModel original, DashboardDataModel updated, EntityRepository.Operation operation)voidprepare(DashboardDataModel dashboardDataModel)This method is used for validating an entity to be created during POST, PUT, and PATCH operations and prepare the entity with all the required attributes and relationships.voidrestorePatchAttributes(DashboardDataModel original, DashboardDataModel updated)PATCH operations can't overwrite certain fields, such as entity ID, fullyQualifiedNames etc.DashboardDataModelsetFields(DashboardDataModel dashboardDataModel, EntityUtil.Fields fields)Set the requested fields in an entity.voidsetFullyQualifiedName(DashboardDataModel dashboardDataModel)Set fullyQualifiedName of an entityvoidstoreEntity(DashboardDataModel dashboardDataModel, boolean update)An entity is stored in the backend database as JSON document.voidstoreRelationships(DashboardDataModel dashboardDataModel)This method is called to store all the relationships of an entity.voidupdate(TaskDetails task, MessageParser.EntityLink entityLink, String newValue, String user)Update an entity based suggested description and tags in the task-
Methods inherited from class org.openmetadata.service.jdbi3.EntityRepository
addDerivedTags, addFollower, addRelationship, addRelationship, addRelationship, applyTags, bulkAddToRelationship, checkSystemEntityDeletion, cleanup, clearFieldsInternal, create, createInternal, createOrUpdate, createOrUpdateInternal, delete, deleteByName, deleteExtensionAtTimestamp, deleteExtensionBeforeTimestamp, deleteFollower, deleteFrom, deleteInternal, deleteInternalByName, deleteRelationship, deleteTo, ensureSingleRelationship, exportToCsv, find, findBoth, findByName, findByNameOrNull, findFrom, findFromRecords, findTo, findToRecords, get, get, getAllowedFieldsCopy, getAllTags, getByName, getByName, getChildren, getCommonFields, getContainer, getCustomPropertyFQN, getCustomPropertyFQNPrefix, getEntitiesFromSeedData, getEntitiesFromSeedData, getEntitiesFromSeedData, getExtension, getExtensionAtTimestamp, getExtensionAtTimestampWithOperation, getFields, getFields, getFollowers, getFromEntityRef, getHref, getIngestionPipelines, getLatestExtensionFromTimeseries, getOwner, getOwner, getParent, getReference, getReferenceByName, getResultList, getResultList, getResultsFromAndToTimestamps, getResultsFromAndToTimestamps, getReviewers, getTags, getTags, getToEntityRef, getVersion, getVotes, importFromCsv, initializeEntity, initSeedDataFromResources, listAfter, listAfterWithSkipFailure, listAll, listBefore, listVersions, patch, populateOwner, postCreate, postDelete, postUpdate, preDelete, prepareInternal, removeExtension, restoreEntity, setFieldsInternal, setInheritedFields, store, storeExtension, storeOwner, storeRelationshipsInternal, storeTimeSeries, storeTimeSeriesWithOperation, update, updateOwner, updateVote, validateOwner, validateRoles, validateUsers, withHref
-
-
-
-
Constructor Detail
-
DashboardDataModelRepository
public DashboardDataModelRepository(CollectionDAO dao)
-
-
Method Detail
-
setFullyQualifiedName
public void setFullyQualifiedName(DashboardDataModel dashboardDataModel)
Description copied from class:EntityRepositorySet fullyQualifiedName of an entity- Overrides:
setFullyQualifiedNamein classEntityRepository<DashboardDataModel>
-
update
public void update(TaskDetails task, MessageParser.EntityLink entityLink, String newValue, String user)
Description copied from class:EntityRepositoryUpdate an entity based suggested description and tags in the task- Overrides:
updatein classEntityRepository<DashboardDataModel>
-
prepare
public void prepare(DashboardDataModel dashboardDataModel)
Description copied from class:EntityRepositoryThis method is used for validating an entity to be created during POST, PUT, and PATCH operations and prepare the entity with all the required attributes and relationships.The implementation of this method must perform the following:
- Prepare the values for attributes that are not required in the request but can be derived on the server side. Example - >FullyQualifiedNames of an entity can be derived from the hierarchy that an entity belongs to .
- Validate all the attributes of an entity.
- Validate all the relationships of an entity. As an example - during table creation, relationships such as Tags, Owner, Databasea table belongs to are validated. During validation additional information that is not required in the create/update request are set up in the corresponding relationship fields.
- Specified by:
preparein classEntityRepository<DashboardDataModel>- See Also:
for an example implementation
-
storeEntity
public void storeEntity(DashboardDataModel dashboardDataModel, boolean update)
Description copied from class:EntityRepositoryAn entity is stored in the backend database as JSON document. The JSON includes some attributes of the entity and does not include attributes such as href. The relationship fields of an entity is never stored in the JSON document. It is always reconstructed based on relationship edges from the backend database.
As an example, when table entity is stored, the attributes such as href and the relationships such as owner, database, and tags are set to null. These attributes are restored back after the JSON document is stored to be sent as response.- Specified by:
storeEntityin classEntityRepository<DashboardDataModel>- See Also:
for an example implementation
-
storeRelationships
public void storeRelationships(DashboardDataModel dashboardDataModel)
Description copied from class:EntityRepositoryThis method is called to store all the relationships of an entity. It is expected that all relationships are already validated and completely setup before this method is called and no validation of relationships is required.- Specified by:
storeRelationshipsin classEntityRepository<DashboardDataModel>- See Also:
for an example implementation
-
setFields
public DashboardDataModel setFields(DashboardDataModel dashboardDataModel, EntityUtil.Fields fields)
Description copied from class:EntityRepositorySet the requested fields in an entity. This is used for requesting specific fields in the object during GET operations. It is also used during PUT and PATCH operations to set up fields that can be updated.- Specified by:
setFieldsin classEntityRepository<DashboardDataModel>
-
clearFields
public DashboardDataModel clearFields(DashboardDataModel dashboardDataModel, EntityUtil.Fields fields)
Description copied from class:EntityRepositorySet the requested fields in an entity. This is used for requesting specific fields in the object during GET operations. It is also used during PUT and PATCH operations to set up fields that can be updated.- Specified by:
clearFieldsin classEntityRepository<DashboardDataModel>
-
restorePatchAttributes
public void restorePatchAttributes(DashboardDataModel original, DashboardDataModel updated)
Description copied from class:EntityRepositoryPATCH operations can't overwrite certain fields, such as entity ID, fullyQualifiedNames etc. Instead of throwing an error, we take lenient approach of ignoring the user error and restore those attributes based on what is already stored in the original entity.- Overrides:
restorePatchAttributesin classEntityRepository<DashboardDataModel>
-
applyTags
public void applyTags(DashboardDataModel dashboardDataModel)
- Overrides:
applyTagsin classEntityRepository<DashboardDataModel>
-
getUpdater
public EntityRepository.EntityUpdater getUpdater(DashboardDataModel original, DashboardDataModel updated, EntityRepository.Operation operation)
- Overrides:
getUpdaterin classEntityRepository<DashboardDataModel>
-
-