Package org.openmetadata.service.jdbi3
Class DatabaseSchemaRepository
java.lang.Object
org.openmetadata.service.jdbi3.EntityRepository<DatabaseSchema>
org.openmetadata.service.jdbi3.DatabaseSchemaRepository
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classclassNested classes/interfaces inherited from class org.openmetadata.service.jdbi3.EntityRepository
EntityRepository.DescriptionTaskWorkflow, EntityRepository.EntityUpdater, EntityRepository.Operation, EntityRepository.TagTaskWorkflow -
Field Summary
FieldsFields inherited from class org.openmetadata.service.jdbi3.EntityRepository
allowedFields, CACHE_WITH_ID, CACHE_WITH_NAME, dao, daoCollection, entityType, putFields, quoteFqn, renameAllowed, searchRepository, supportsDataProducts, supportsDomain, supportsExperts, supportsExtension, supportsFollower, supportsLifeCycle, supportsOwner, supportsReviewers, supportsSearch, supportsSoftDelete, supportsStyle, supportsTags, supportsVotes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddDatabaseSchemaProfilerConfig(UUID databaseSchemaId, DatabaseSchemaProfilerConfig databaseSchemaProfilerConfig) voidclearFields(DatabaseSchema schema, EntityUtil.Fields fields) Set the requested fields in an entity.deleteDatabaseSchemaProfilerConfig(UUID databaseSchemaId) exportToCsv(String name, String user) Override this method to support downloading CSV functionalitygetDatabaseSchemaProfilerConfig(DatabaseSchema databaseSchema) getParentEntity(DatabaseSchema entity, String fields) getUpdater(DatabaseSchema original, DatabaseSchema updated, EntityRepository.Operation operation) importFromCsv(String name, String csv, boolean dryRun, String user) Load CSV provided for bulk uploadvoidprepare(DatabaseSchema schema, boolean update) 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(DatabaseSchema original, DatabaseSchema updated) PATCH operations can't overwrite certain fields, such as entity ID, fullyQualifiedNames etc.voidsetFields(DatabaseSchema schema, EntityUtil.Fields fields) Set the requested fields in an entity.voidsetFullyQualifiedName(DatabaseSchema schema) Set fullyQualifiedName of an entityvoidsetInheritedFields(DatabaseSchema schema, EntityUtil.Fields fields) This method is called to set inherited fields that an entity inherits from its parent.voidstoreEntity(DatabaseSchema schema, boolean update) An entity is stored in the backend database as JSON document.voidstoreRelationships(DatabaseSchema schema) This method is called to store all the relationships of an entity.Methods inherited from class org.openmetadata.service.jdbi3.EntityRepository
addFollower, addRelationship, addRelationship, addRelationship, addServiceRelationship, applyColumnTags, applySuggestion, applyTags, applyTags, bulkAddToRelationship, bulkAssetsOperation, checkSystemEntityDeletion, cleanup, clearFieldsInternal, copy, create, createInternal, createOrUpdate, delete, deleteByName, deleteExtensionAtTimestamp, deleteExtensionBeforeTimestamp, deleteFollower, deleteFrom, deleteFromSearch, deleteInternal, deleteInternalByName, deleteRelationship, deleteTo, ensureSingleRelationship, find, findBoth, findByName, findByNameOrNull, findFrom, findFromRecords, findTo, findToRecords, get, get, getAllowedFieldsCopy, getAllTags, getByName, getByName, getChildren, getCommonFields, getContainer, getContainer, getCustomPropertyFQN, getCustomPropertyFQNPrefix, getDomain, getEntitiesFromSeedData, getEntitiesFromSeedData, getEntitiesFromSeedData, getExperts, getExtension, getExtensionAtTimestamp, getFields, getFields, getFollowers, getFromEntityRef, getHref, getIngestionPipelines, getLatestExtensionFromTimeSeries, getOwner, getOwner, getParent, getReference, getReferenceByName, getResultList, getResultList, getResultsFromAndToTimestamps, getResultsFromAndToTimestamps, getReviewers, getSuggestionFields, getSuggestionWorkflow, getTags, getTags, getTagsByPrefix, getTaskWorkflow, getToEntityRef, getVersion, getVotes, inheritDomain, inheritExperts, inheritOwner, inheritReviewers, initializeEntity, initSeedDataFromResources, listAfter, listAfterWithSkipFailure, listAll, listBefore, listVersions, patch, populateOwner, postCreate, postDelete, postUpdate, preDelete, prepareInternal, removeExtension, restoreEntity, restoreFromSearch, setFieldsInternal, store, storeDataProducts, storeDomain, storeExtension, storeOwner, storeRelationshipsInternal, storeTimeSeries, update, updateOwner, updateVote, validateColumnTags, validateDataProducts, validateDomain, validateDomain, validateOwner, validateRoles, validateTags, validateTags, validateTaskThread, validateUsers, withHref
-
Field Details
-
DATABASE_SCHEMA_PROFILER_CONFIG_EXTENSION
- See Also:
-
DATABASE_SCHEMA_PROFILER_CONFIG
- See Also:
-
-
Constructor Details
-
DatabaseSchemaRepository
public DatabaseSchemaRepository()
-
-
Method Details
-
setFullyQualifiedName
Description copied from class:EntityRepositorySet fullyQualifiedName of an entity- Overrides:
setFullyQualifiedNamein classEntityRepository<DatabaseSchema>
-
prepare
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<DatabaseSchema>- See Also:
-
storeEntity
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<DatabaseSchema>- See Also:
-
storeRelationships
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<DatabaseSchema>- See Also:
-
setFields
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<DatabaseSchema>
-
clearFields
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<DatabaseSchema>
-
setInheritedFields
Description copied from class:EntityRepositoryThis method is called to set inherited fields that an entity inherits from its parent.- Overrides:
setInheritedFieldsin classEntityRepository<DatabaseSchema>- See Also:
-
restorePatchAttributes
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<DatabaseSchema>
-
getParentEntity
- Overrides:
getParentEntityin classEntityRepository<DatabaseSchema>
-
getUpdater
public EntityRepository<DatabaseSchema>.EntityUpdater getUpdater(DatabaseSchema original, DatabaseSchema updated, EntityRepository.Operation operation) - Overrides:
getUpdaterin classEntityRepository<DatabaseSchema>
-
exportToCsv
Description copied from class:EntityRepositoryOverride this method to support downloading CSV functionality- Overrides:
exportToCsvin classEntityRepository<DatabaseSchema>- Throws:
IOException
-
importFromCsv
public CsvImportResult importFromCsv(String name, String csv, boolean dryRun, String user) throws IOException Description copied from class:EntityRepositoryLoad CSV provided for bulk upload- Overrides:
importFromCsvin classEntityRepository<DatabaseSchema>- Throws:
IOException
-
addDatabaseSchemaProfilerConfig
public DatabaseSchema addDatabaseSchemaProfilerConfig(UUID databaseSchemaId, DatabaseSchemaProfilerConfig databaseSchemaProfilerConfig) -
getDatabaseSchemaProfilerConfig
-
deleteDatabaseSchemaProfilerConfig
-