Package org.openmetadata.service.jdbi3

Class DatabaseRepository

java.lang.Object

org.openmetadata.service.jdbi3.EntityRepository<Database>

org.openmetadata.service.jdbi3.DatabaseRepository

public class DatabaseRepository
extends EntityRepository<Database>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatabaseRepository.DatabaseCsv
class	DatabaseRepository.DatabaseUpdater

Nested classes/interfaces inherited from class org.openmetadata.service.jdbi3.EntityRepository

EntityRepository.DescriptionTaskWorkflow, EntityRepository.EntityUpdater, EntityRepository.Operation, EntityRepository.TagTaskWorkflow

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATABASE_PROFILER_CONFIG
static final String	DATABASE_PROFILER_CONFIG_EXTENSION

Fields 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

Constructor	Description
DatabaseRepository()

Method Summary

Modifier and Type	Method	Description
Database	addDatabaseProfilerConfig(UUID databaseId, DatabaseProfilerConfig databaseProfilerConfig)
void	clearFields(Database database, EntityUtil.Fields fields)	Set the requested fields in an entity.
Database	deleteDatabaseProfilerConfig(UUID databaseId)
String	exportToCsv(String name, String user)	Override this method to support downloading CSV functionality
DatabaseProfilerConfig	getDatabaseProfilerConfig(Database database)
EntityInterface	getParentEntity(Database entity, String fields)
EntityRepository<Database>.EntityUpdater	getUpdater(Database original, Database updated, EntityRepository.Operation operation)
CsvImportResult	importFromCsv(String name, String csv, boolean dryRun, String user)	Load CSV provided for bulk upload
void	prepare(Database database, 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.
void	restorePatchAttributes(Database original, Database updated)	PATCH operations can't overwrite certain fields, such as entity ID, fullyQualifiedNames etc.
void	setFields(Database database, EntityUtil.Fields fields)	Set the requested fields in an entity.
void	setFullyQualifiedName(Database database)	Set fullyQualifiedName of an entity
void	storeEntity(Database database, boolean update)	An entity is stored in the backend database as JSON document.
void	storeRelationships(Database database)	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, setInheritedFields, store, storeDataProducts, storeDomain, storeExtension, storeOwner, storeRelationshipsInternal, storeTimeSeries, update, updateOwner, updateVote, validateColumnTags, validateDataProducts, validateDomain, validateDomain, validateOwner, validateRoles, validateTags, validateTags, validateTaskThread, validateUsers, withHref

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DATABASE_PROFILER_CONFIG_EXTENSION

public static final String DATABASE_PROFILER_CONFIG_EXTENSION

See Also:

• Constant Field Values

DATABASE_PROFILER_CONFIG

public static final String DATABASE_PROFILER_CONFIG

See Also:

• Constant Field Values

Constructor Details

DatabaseRepository

public DatabaseRepository()

Method Details

setFullyQualifiedName

public void setFullyQualifiedName(Database database)

Description copied from class: EntityRepository

Set fullyQualifiedName of an entity

Overrides:

setFullyQualifiedName in class EntityRepository<Database>

prepare

public void prepare(Database database,
 boolean update)

Description copied from class: EntityRepository

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.

The implementation of this method must perform the following:

1. 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 .
2. Validate all the attributes of an entity.
3. 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.

At the end of this operation, entity is expected to be valid and fully constructed with all the fields that will be sent as payload in the POST, PUT, and PATCH operations response.

Specified by:

prepare in class EntityRepository<Database>

See Also:

• for an example implementation

storeEntity

public void storeEntity(Database database,
 boolean update)

Description copied from class: EntityRepository

An 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:

storeEntity in class EntityRepository<Database>

See Also:

• for an example implementation

storeRelationships

public void storeRelationships(Database database)

Description copied from class: EntityRepository

This 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:

storeRelationships in class EntityRepository<Database>

See Also:

• for an example implementation

getParentEntity

public EntityInterface getParentEntity(Database entity,
 String fields)

Overrides:

getParentEntity in class EntityRepository<Database>

exportToCsv

public String exportToCsv(String name,
 String user)
                   throws IOException

Description copied from class: EntityRepository

Override this method to support downloading CSV functionality

Overrides:

exportToCsv in class EntityRepository<Database>

Throws:

IOException

importFromCsv

public CsvImportResult importFromCsv(String name,
 String csv,
 boolean dryRun,
 String user)
                              throws IOException

Description copied from class: EntityRepository

Load CSV provided for bulk upload

Overrides:

importFromCsv in class EntityRepository<Database>

Throws:

IOException

setFields

public void setFields(Database database,
 EntityUtil.Fields fields)

Description copied from class: EntityRepository

Set 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:

setFields in class EntityRepository<Database>

clearFields

public void clearFields(Database database,
 EntityUtil.Fields fields)

Description copied from class: EntityRepository

Set 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:

clearFields in class EntityRepository<Database>

restorePatchAttributes

public void restorePatchAttributes(Database original,
 Database updated)

Description copied from class: EntityRepository

PATCH 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:

restorePatchAttributes in class EntityRepository<Database>

getUpdater

public EntityRepository<Database>.EntityUpdater getUpdater(Database original,
 Database updated,
 EntityRepository.Operation operation)

Overrides:

getUpdater in class EntityRepository<Database>

addDatabaseProfilerConfig

public Database addDatabaseProfilerConfig(UUID databaseId,
 DatabaseProfilerConfig databaseProfilerConfig)

getDatabaseProfilerConfig

public DatabaseProfilerConfig getDatabaseProfilerConfig(Database database)

deleteDatabaseProfilerConfig

public Database deleteDatabaseProfilerConfig(UUID databaseId)